Skip to content
This repository

Sublime Text plugin that aims to replace the Eclipse-based Force.com IDE

README.md

MavensMate for Sublime Text

MavensMate for Sublime Text is a plugin that aims to replicate the functionality of the Eclipse-based Force.com IDE. Its goal is to allow developers to work inside Sublime Text for all their Force.com-related tasks.

  • Create & Edit Salesforce.com projects with specific package metadata
  • Create & compile Apex Classes, Apex Trigger, Visualforce Pages, and Visualforce Components
  • Compile and retrieve other Salesforce.com metadata
  • Run Apex test methods and visualize test successes/failures & coverage
  • Play Pacman, Tetris, Galaga, Quake, and Mortal Kombat while your Apex unit tests and deploys run
  • Deploy metadata to other Salesforce.com orgs
  • Apex Execute Anonymous
  • Create Apex Execution Overlay Actions "checkpoints" (tooling API)
  • Download Apex Logs (tooling API)
  • Apex & Visualforce Code Assist

For detailed information and documentation, please visit mavensmate.com

Sublime Text 3 plugin (current stable version)

Install

Mac OSX (tested on Mac OSX 10.7+)

  1. You must have MavensMate.app installed. Download MavensMate.app here and place in /Applications
  2. To install the Sublime Text 3 Plugin for MavensMate, go to the "Plugins" menu in MavensMate.app and install the plugin.

Windows (tested on Windows 7, 8)

You must have git installed and it MUST be available from the command line (see screenshot for option to select when installing Git). Download Git

Installer
  1. Download and run the MavensMate.exe Windows Installer
Manual Install

If you have trouble installing via the MavensMate.exe installer, you can run MavensMate with a system Python install:

  1. You must have python 2.7 and git installed
  2. Install required modules $ easy_install jinja2 suds keyring markupsafe pyyaml requests
  3. Download and run install script: https://raw.github.com/joeferraro/MavensMate-SublimeText/master/install.py $ python install.py
  4. Set your "mm_python_location" user setting (Mavensmate > Settings > User) to the location of your Python install. For example, "C:\\Python27\\python.exe"
  5. Set "mm_debug_mode" to true

Linux (tested on Ubuntu 12)

  1. You must have python 2.7 and git installed
  2. Install required modules $ easy_install jinja2 suds keyring markupsafe pyyaml requests
  3. Run install script $ python < <(curl -s https://raw.github.com/joeferraro/MavensMate-SublimeText/master/install.py)
  4. Set your "mm_python_location" user setting (Mavensmate > Settings > User) to the location of your Python install. For example, "/usr/bin/python"
  5. Alias your subl command line tool to /usr/local/bin
$ cd /usr/local/bin
$ sudo ln -s /usr/bin/subl subl

Sublime Text 2 plugin (no longer supported)

Mac OSX (OSX 10.7+ only)

You must have MavensMate.app 0.34 installed. Download MavensMate.app v0.34 and place in /Applications

Install

To install the Sublime Text 2 Plugin for MavensMate, go to the "Plugins" menu in MavensMate.app and install the plugin.

Updating MavensMate for Sublime Text

If mm_check_for_updates is set to true, MavensMate will check for updates when Sublime Text starts up.

Mac OSX (OSX 10.7+ only)

If an update is available, you can update the plugin through the "Plugins" panel in MavensMate.app.

Windows

If an update is available, you will be given the option to run the update installer. You will need to close Sublime Text in order to run the update.

Linux

If an update is available, you will be given the option to run the update installer. Once the update is complete, you will need to restart Sublime Text.

Documentation

http://mavensmate.com/Plugins/Sublime_Text/Overview

Screenshots

Project Wizard

Apex Test Runner

Apex Execute Anonymous

Quick Panel

Apex/Visualforce Code Assist

Something went wrong with that request. Please try again.