Primary goal of tooling-force.com is to provide the means of interacting with force.com Medatata API and Tooling API from various command line tools and editor plugins like vim-force.com.
Current version of this tool is similar in functionality to Force.com Migration Tool with one important difference - it is designed with scripting languages (shell, .bat, etc) in mind. All operations can be done by constructing appropriate command line, no messing with XML is required. Results are returned in easy to parse formats.
- Retrieve - metadata retrieval
- Deploy (all, specific files)
- Run Tests (and report code coverage)
- Describe Metadata - load full metadata description (result is provided in JSON format)
- List Metadata - list members of specific metadata type (e.g. list all Apex Classes)
- ExecuteAnonymous - run arbitrary piece of Apex Code
- ListConflicts - display list of local files which have been updated in SFDC since last deployment
- Execute SOQL query
Also supported a "project like" mode - where relevant metadata about deployments and retrievals is cached in a set of local files and makes possible operations like:
- Deploy modified files
- List Modified files
- Conflict checking before deployment (test if file(s) you are trying to deploy have been modified by someone else in SFDC since your last Refresh or Deployment.
- list candidates for Apex and SOQL auto-completion (note: current version is "work in progress")
- find definition (go-to-symbol) in apex classes
Java JDK/JRE, Version 8 or greater
Download lastest .jar file from releases page.
Assuming .jar file name is tooling-force.com-0.1.jar you can run it like so:
java -jar tooling-force.com-0.1.jar
This will display main help and list of supported commands/actions. In order to get help for specific command run it like so:
java -jar tooling-force.com-0.1.jar --help=<action-name>
When connection requires proxy it can be passed as java -D params or as tooling-force.com.jar command line params, e.g.
java -jar tooling-force.com-0.1.jar --action=refresh ... --http.proxyHost=localhost --http.proxyPort=8888 --http.proxyUser=some --http.proxyPassword=pass
git clone [email protected]:neowit/tooling-force.com.git
- Generate partner-api, apex-api, metadata-api and tooling-api jars using instructions from Force.com Web Service Connector (WSC)
- rename and place generated files under lib folder such as the file structure looks like this (assuming API v32.0)
lib/ ----apex-wsdl-32.0.jar ----partner-wsdl-32.0.jar ----metadata-wsdl-32.0.jar ----tooling-wsdl-32.0.jar ----force-wsc-32.0.0.jar ----antlr-runtime-4.4.jar project/ src/ assembly.sbt build.sbt
- make sure line
test in assembly := {}inassembly.sbtis not commented out. If it is then tests will run and your build will fail (this is due to some tests dependent on a specific structure of the Org against which tests are run)
cd tooling-force.com/src/main/java
antlr4 -o ./com/neowit/apex/parser/antlr Apexcode.g4
antlr4 -o ./com/neowit/apex/parser/antlr Soql.g4
cd ../../../
sbt assembly
Note - the end result will be .jar file which does NOT contain scala runtime. In order to run that jar you will need to either run it from you IDE (with scala runtime specified) or use scala directly, e.g.:
$ scala tooling-force.com-assembly-0.1-SNAPSHOT.jar
##CREDITS
Author: Andrey Gavrikov
Copyright (c) 2013-2016, Andrey Gavrikov. All rights reserved.
License: LGPL v3 http://www.gnu.org/licenses/
Third-Party Licenses: