Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 3.91 KB

README.md

File metadata and controls

76 lines (48 loc) · 3.91 KB
Raw

A command line utility for working with salesforce.com Tooling & Metadata API

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.

DESCRIPTION

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.

FEATURES

Non project specific:

  • 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

Project specific

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
  • login using username/password or oauth2

System requirements

Java JDK/JRE, Version 8 or greater

Installation

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>

Proxy

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

CREDITS

Author: Andrey Gavrikov

Legal stuff

Copyright (c) 2013-2018, Andrey Gavrikov. All rights reserved.

License: LGPL v3 http://www.gnu.org/licenses/

Third-Party Licenses: