A command-line interface to force.com
Can be downloaded from the Current Release Page or by visiting the CLI Home Page.
$ go install github.com/ForceCLI/force@latest
See docs/force.md for all supported commands.
Tab completion simplifies use of the force CLI.
Enable bash completion or see force completion --help for other options.
$ source <(force completion bash)
Usage:
force [command]
Available Commands:
active Show or set the active force.com account
apex Execute anonymous Apex code
apiversion Display/Set current API version
bigobject Manage big objects
bulk Load csv file or query data using Bulk API
bulk2 Load csv file or query data using Bulk API 2.0
completion Generate the autocompletion script for the specified shell
create Creates a new, empty Apex Class, Trigger, Visualforce page, or Component.
datapipe Manage DataPipes
describe Describe the object or list of available objects
eventlogfile List and fetch event log file
export Export metadata to a local directory
fetch Export specified artifact(s) to a local directory
field Manage SObject fields
help Help about any command
import Import metadata from a local directory
limits Display current limits
log Fetch debug logs
login force login [-i=<instance>] [<-u=username> <-p=password>] [-scratch] [-s]
logins List force.com logins used
logout Log out from Force.com
notify Should notifications be used
oauth Manage ConnectedApp credentials
open Open a browser window, logged into an authenticated Salesforce org
package Manage installed packages
password See password status or reset password
push Deploy metadata from a local directory
query Execute a SOQL statement
quickdeploy Quick deploy validation id
record Create, modify, or view records
rest Execute a REST request
security Displays the OLS and FLS for a given SObject
sobject Manage standard & custom objects
test Run apex tests
trace Manage trace flags
usedxauth Authenticate with SFDX Scratch Org User
version Display current version
whoami Show information about the active account
Flags:
-a, --account username account username to use
-h, --help help for force
When a stored force session is not available, `--account` automatically falls back to matching SFDX usernames or aliases and reuses that authentication.
Use "force [command] --help" for more information about a command.
When you login using the CLI a record of the login is saved. Eventually your token will expire requiring re-authentication. The default login is for all production instances of salesforce.com. Two predefined non-production instances are available using the test and pre aliases. You can set an arbitrary instance to log in to by specifying the instance url in the form of subdomain.domain. For example login-blitz.soma.salesforce.com.
force login # log in to last environment
force login -i=login # log in to production or developer org
force login -i=test # log in to sandbox org
force login -i=pre # log in to prerelease org
force login -u=un [-p=pw] # log in using OAuth Username-Password flow
force login -i=test -u=un -p=pw # log in to sandbox org using OAuth Username-Password flow
force login -i=<instance> -u=un -p=pw # internal only
Logout will delete your authentication token and remove the saved record of that login.
force logout -u=user@example.org
Logins will list all the user names that you have used to authenticate with the instance URL and org namespace associated with each one. The active login will be indicated behind the login name in red.
force logins
The namespace is the org's Organization.NamespacePrefix, recorded when you log in or when the session is refreshed. Use --namespace to list only the logins for orgs with a given namespace.
force logins --namespace myns
Active without any arguments will display the currently acctive login that you are using. You can also supply a username argument that will set the active login to the one corresponding to the username argument. Note, just because you set a login as active, does not mean that the token is necessarily valid.
force active
force active -a dave@demo.1
Whoami will display detailed user information about the currently active logged in user. This is Force.com specific information.
force whoami
Sobject command gives you access to creating and deleting schema objects. The list argument will list ALL of the objects, both standard and custom, in your org.
force sobject list
force sobject create <object> [<field>:<type>]...
force sobject delete <object>
Field gives you the ability to create, list and delete the fields on an object. Fields need to be created one at a time. You can also set required and optional attributes for the type of field. All defaultable field attributes will be defaulted based on the defaults in the web UI.
force field list Todo__c
force field create Todo__c Due:DateTime required:true
force field delete Todo__c Due
Push gives you the ability to push specified resources to force.com. The resource will be pulled from ./metatdata/{type}/
force push -t(ype) StaticResource -n(ame) MyResource.resource
force -type ApexClass -name MyClass.cls
force -t ApexPage -n MyPage.page
You can also push all of a specific type of resource from a given folder.
force push -t StaticResource -f metadata/staticresources/
force push -t ApexClass -f metadata/classes/
force push -t ApexPage -f metadata/pages/
Files in source (sfdx) format are converted to metadata format before the deploy. An object's files, such as objects/Account/Account.object-meta.xml and objects/Account/fields/Status__c.field-meta.xml, are composed into objects/Account.object, and a file such as customMetadata/Type.Record.md-meta.xml is deployed as customMetadata/Type.Record.md.
force push -f src/objects/Account
force push -f src/objects/Account/fields/Status__c.field-meta.xml
Import allows you to import code from local directory. This makes a lot of senses when you want to import code from local directory to a brand new org. This import method import codes from metadata folder not from your src folder
Make sure you have the metadata folder, in case you only have src folder, simply replicate it
force import
Sample folder structure
|-metadata
| |-aura
| |-corsWhitelistOrigins
| |-remoteSiteSettings
| |-staticresources
| |package.xml
Fetch retrieves specific metadata into a local directory.
force fetch -t CustomField -n Opportunity.Buyer__c -d src
Some metadata format files hold several components, such as the fields, list
views, and record types in objects/Opportunity.object, or the rules in
workflows/Case.workflow. When fetch retrieves one of these child components
and the file already exists, it adds or replaces the retrieved components in
the existing file and keeps the rest of the file. If you fetch the parent
component itself, such as -t CustomObject -n Opportunity, the retrieved file
replaces the existing one. Retrieving an unmanaged package with -t package
always replaces existing files.
Fetch also takes the paths of local files or directories, and retrieves the components they hold. The retrieved metadata is written back in the format of the paths given, so a path in a source (sfdx) format project updates the source format files:
force fetch force-app/main/default/objects/Account/fields/Email_ID__c.field-meta.xml
Retrieved objects and object translations are split into a file per child
component. Fetching a field writes only the field's file; the object's
Account.object-meta.xml file is written only when the object itself is
fetched.
A source format project can organize a type's files into subdirectories. Fetch and push identify these components by file name, and fetch writes them back to the path given:
force fetch force-app/main/default/classes/service/__tests__/WidgetTest.cls
Directories in a project can have the name of a metadata type without being
that type's directory, so fetch and push find a path's type from the file's
suffix first: classes/triggers/WidgetHandler.cls and
force-app/reports/main/default/classes/Widget.cls are both Apex classes. A
directory is resolved the same way from a file inside it. A file whose suffix
does not identify its type, such as lwc/settings/settings.js, belongs to the
outermost directory of a type whose files have arbitrary names (lwc, aura,
experiences, staticresources, documents), and otherwise to the nearest
directory that names a metadata type. For a path in a package directory listed
in sfdx-project.json, directories above the package directory are not
considered.
Export allows you to fetch all codes from your org to local machine. This command will export all the codes to a local folder called src
force export
|-src
| |-aura
| |-corsWhitelistOrigins
| |-remoteSiteSettings
| |-staticresources
| |package.xml
Includes notification library, beeep, that displays desktop notifications across platforms. Currently, only the push and test methods are displaying notifications.
Bulk API 2.0 provides a REST-based interface for data loading and querying with automatic batch management. Unlike Bulk API 1.0, it handles batch splitting automatically and uses CSV format.
# Insert records
force bulk2 insert Account accounts.csv --wait
# Update records
force bulk2 update Account updates.csv --wait
# Upsert records using external ID
force bulk2 upsert -e External_Id__c Account data.csv --wait
# Delete records
force bulk2 delete Account deletes.csv --wait
# Hard delete records
force bulk2 hardDelete Account harddeletes.csv --wait
# Query records
force bulk2 query "SELECT Id, Name FROM Account" --wait
# Query including deleted and archived records
force bulk2 query "SELECT Id, Name FROM Account" --query-all --wait
# Check job status
force bulk2 job <jobId>
# List all ingest jobs
force bulk2 jobs
# List all query jobs
force bulk2 jobs --query
# Get job results
force bulk2 results <jobId>
# Get only failed results
force bulk2 results <jobId> --failed
# Abort a job
force bulk2 abort <jobId>
# Delete a job
force bulk2 delete-job <jobId>
Limits will display limits information for your organization.
- Max is the limit total for the organization
- Remaining is the total number of calls or events left for the organization
The list is limited to those exposed by the REST API.
force limits
Set the API version to be used when interacting with the Salesforce org.
force login stores the highest API version that the org supports, unless a
version is passed with --api-version. If the org's versions can't be read,
the login uses the default version, 68.0. Use force apiversion to change the
version of a stored session.
force apiversion nn.0
Replay an Apex debug log in a terminal debugger. The debugger steps through
the statements recorded in the log, showing the call stack, local and static
variables, and System.debug output at each statement. Breakpoints can be
set on any line of a class or trigger that ran in the log.
force log debug 07L5g00000AbCdEFG # replay a log from the org
force log debug --file apex.log # replay a log saved to a file
force trace start --replay # log Apex at FINEST for later replay
force log debug --web 07L5g00000AbCdEFG # replay a log in a browser
force apex --debug script.apex # run anonymous Apex, then replay it
force test --debug CalcTest.addsTwo # run tests, show results, then replay them
The log must have been captured with APEX_CODE at FINEST. force apex --debug and force test --debug capture such a log: while the code or tests
run, your DEVELOPER_LOG trace flag uses the Force_CLI_Replay debug level
(created if needed), and afterwards the trace flag gets its previous debug
level and expiration date back. A trace flag that had already expired is set
to expire one minute later, because Salesforce does not accept an expiration
date in the past. All of the tests in a force test --debug run share one
log, fetched by the log ID in the runTests result. --debug cannot be
combined with force apex --test, whose test run Salesforce does not log, or
with force test --integration.
Class and trigger source is fetched from the org by the ID recorded in the log, so a class changed after the log was captured will show lines that do not match the code that ran. Classes in managed packages have no source to show.
Keys: n step over, s step in, o step out, c continue, p step back
to the previous statement in the current method or a caller, b set or
remove a breakpoint, f open a class or trigger, r restart, tab move
between panes, enter expand a variable, q quit.
The numbers of lines on which a statement ran in the log are shown brighter
than the others. A breakpoint can stop only on those lines; a breakpoint on
any other line, such as a comment or a constant declared with its value, is
shown as ○. Stepping does not stop in the static initialization of a class
(the assignments to its static variables before the class is first used),
though a breakpoint there does. Statements that the log records inside
Salesforce's own methods, such as the Database.DMLOptions constructor, are
skipped, because their line numbers refer to Salesforce's code.
The log records a variable's value only when the variable is assigned. A
list, set, or map changed by a method such as add or put keeps the value
of its last assignment, so collections are shown with the line of that
assignment (accounts = [] as of line 109). Collections above a size limit
are logged as List of size 50 too large to display, without their contents.
--web, on force log debug and with --debug on force apex and force test, opens the debugger in a browser instead of the terminal. It is served
on 127.0.0.1, with a random token in the URL that the page sends with each
request, until the page's Quit button is pressed or force is stopped with
Ctrl-C. Clicking a line number sets or removes a breakpoint, and the keys are
the same as in the terminal.
To see the full contents of variables at a line, set a checkpoint there. Salesforce saves a heap dump the first time execution reaches the line, and the debugger shows the variables, objects, and collections from the dump at that statement:
force test --debug --checkpoint AccountService:42 AccountServiceTest
force apex --debug --checkpoint AccountService:42 script.apex
A checkpoint is given as Class:line, and up to 5 can be set; Salesforce
allows a user 5 checkpoints, including any set in VS Code. The checkpoints
are deleted after the run. force log debug also fetches the heap dumps of a
log captured with checkpoints set elsewhere, for as long as Salesforce keeps
them.
# set these environment variables in your startup scripts
export GOPATH=~/go
export PATH="$GOPATH/bin:$PATH"
# download the source and all dependencies
$ go get -u github.com/ForceCLI/force
$ cd $GOPATH/src/github.com/ForceCLI/force
# to compile and test modifications
$ go get .
$ force
Starting from Windows 10 Creator Update (version 1703), you now can use force cli within Windows Bash. To access force cli from WSL, you can call force.exe
For ease of use you can add the following simple alias
alias force=force.exe


