Skip to content


Subversion checkout URL

You can clone with
Download ZIP
MavensMate is a Node.js application that powers open source Salesforce1/ IDEs in various text editors across various platforms
JavaScript CSS HTML Python Apex Visual Basic Other
Latest commit 3529e3c @joeferraro Merge pull request #605 from joeferraro/auth_load_error
potential fix for credential load bugs

MavensMate - Open Source IDEs for Salesforce

MavensMate is a powerful tool for building Salesforce IDEs. Develop Salesforce applications in your favorite text editors, like Sublime Text and Atom. MavensMate is created and maintained by Joe Ferraro with help from these contributors.

For more information, check out!

Circle CI

NPM Version Coverage Status



MavensMate-app is an application that bundles the local MavensMate server and UIs into a desktop app that powers the MavensMate Sublime Text and Atom plugins. For more information and to download MavensMate-app, visit the GitHub project.


MavensMate API

You can build your own Salesforce IDEs by integrating with the APIs exposed in this project. For Node.js projects, you can simply require('mavensmate'). For other types of projects, you may use the command line interface (see below, full documentation forthcoming).


npm install mavensmate -g


Node Application

var mavensmate = require('mavensmate');
var client = mavensmate.createClient({
    name: 'my-mavensmate-client'
  .then(function(res) {
    return client.executeCommand('compile-project');
  .then(function(res) {
    console.log('command result', res);

Command Line

mavensmate <command>


mavensmate new-project <<< '{ "name" : "myproject", "workspace" : "/path/to/workspace", "username" : "", "password" : "foo", package: { "ApexClass" : "*" } }'

cd path/to/workspace/myproject

mavensmate edit-project <<< '{ "package" : { "ApexClass": [ "MyTestClass", "MyTestClass2" ], "ApexPage": "*" } }'

mavensmate update-creds myPassword123!

mavensmate clean-project

mavensmate compile-project

mavensmate compile-metadata path/to/MyTestClass.cls

mavensmate delete-metadata path/to/

mavensmate start-logging

mavensmate run-tests path/to/MyTestClass.cls

mavensmate run-tests <<< '{ "paths" : [ "/path/to/MyTestClass.cls", "/path/to/MyTestClass2.cls" ] }'

mavensmate get-coverage path/to/MyTestClass.cls

mavensmate get-coverage --global

mavensmate stop-logging

mavensmate new-resource-bundle path/to/my/static/resource

mavensmate deploy-resource-bundle path/to/my/resource/bundle

mavensmate new-connection coolPassword!

mavensmate deploy --ui

For a full list of commands, see the lib/mavensmate/commands directory. We will continue to build out this documentation with a full list of commands, including payload parameters.

Run Functional/Unit Tests

You must set the following environment variables before running tests:



For verbose logging while running tests, set MAVENSMATE_DEBUG_TESTS to true

To run all unit and functional tests:

npm test

To run a specific test you may use the mocha command line interface. Examples:

mocha --recursive --grep clean-project

mocha --recursive --grep 'index-metadata|project-unit'

To generate a coverage report, which will be located at test/coverage.html:

make coverage

Active Plugins

MavensMate for Sublime Text

Build Salesforce applications from Sublime Text 3

MavensMate for Atom (beta)

Build Salesforce applications from GitHub's Atom text editor.

MavensMate for Visual Studio Code (coming soon)

MavensMate is working with Microsoft to create an official plugin for Visual Studio Code!

Bugs and feature requests

Have a bug or a feature request? If it's specific to the MavensMate core, please open a new issue. Before opening any issue, please search for existing issues.

If you have an issue with the Sublime Text or Atom plugin specifically, please open an issue at the proper project.

Always include your MavensMate version number, platform, and specific steps to reproduce.



MavensMate's documentation is built with and publicly available on

Something went wrong with that request. Please try again.