Skip to main content




Getting Started with MavensMate


MavensMate is a collection of open source projects that aims to make building Salesforce applications accessible to developers who prefer to build applications using their local machine in text editors like Sublime Text, Atom, and Visual Studio Code.

After reading this article you will be able to 

  • Install MavensMate desktop application
  • Install Visual Studio Code Text Editor
  • Install the MavensMate Extension for VS Code
  • View / Change Custom code from your personal text editor


Step One: MavensMate desktop application 

1. To install the MavensMate desktop app click here

2. Click on the executable file


3. Open the downloaded file when finished

1.3.png 1.3.2.png


Note: After step 3 MavensMate will start installing and open when complete

4. Click New Project


5. Select the Salesforce Environment

6. Click Connect button

1.5 1.6.png

7. Login to your Salesforce org

8. Give the  project a name

9. Select the advanced tab

10. Include any metadata

11. Click Create Project

1.10 1.11 1.12.png

 12. Click Edit Project

1.12.png 1.12.1.png


Note: After completing step 12 MavensMate will load  the selected metadata from step 10

13. Click Select All

14. Click Update Project

1.13 1.14.png

Step Two:  Visual Studio Code and MavensMate extension 

1. To Download Visual Studio Code click here

2. Launch VS code

3. Click the extensions icon

4. In the marketplace search bar type MavensMate

5. Click Install

2.3 2.4 2.5.png

6. Click File

7 Select Open Folder

8. Select the project you created earlier 

9. Click the arrow icon next to the src

10. Click the arrow icon next to the file type you would like to view

11. Double click the file to view the code

2.9 2.10 2.11.png