Commands for interacting with metadata in Salesforce orgs.
This plugin is bundled with the Salesforce CLI. For more information on the CLI, read the getting started guide.
We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific plugin version or tag if needed.
sfdx plugins:install [email protected]Please report any issues at https://github.com/forcedotcom/cli/issues
- Please read our Code of Conduct
- Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
- Fork this repository.
- Build the plugin locally
- Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
- Edit the code in your fork.
- Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
- Sign CLA (see CLA below).
- Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
To build the plugin locally, make sure to have yarn installed and run the following commands:
# Clone the repository
git clone [email protected]:salesforcecli/plugin-source
# Install the dependencies and compile
yarn install
yarn buildTo use your plugin, run using the local ./bin/run or ./bin/run.cmd file.
# Run using local run file.
./bin/run source:There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
# Link your plugin to the sfdx cli
sfdx plugins:link .
# To verify
sfdx plugins$ npm install -g @salesforce/plugin-source
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@salesforce/plugin-source/1.8.16 linux-x64 node-v12.22.10
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...sfdx force:mdapi:beta:convert -r <directory> [-d <directory>] [-p <array> | -x <string> | -m <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:mdapi:beta:deploy [-d <directory>] [-w <minutes>] [-q <id> | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g | -c] [-f <filepath>] [-s] [--soapdeploy] [--purgeondelete] [-u <string>] [--apiversion <string>] [--verbose] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:mdapi:beta:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:mdapi:beta:retrieve -r <directory> [-k <filepath> | -d <directory> | -p <array>] [-s] [-n <string>] [-z] [-w <minutes>] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:mdapi:beta:retrieve:report [-r <directory>] [-i <id>] [-n <string>] [-z] [-w <minutes>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:mdapi:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:mdapi:describemetadata [-f <filepath>] [-u <string>] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:mdapi:listmetadata -m <string> [-f <filepath>] [--folder <string>] [-u <string>] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:convert [-r <directory>] [-d <directory>] [-n <string>] [-p <array> | -x <string> | -m <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:delete [-w <minutes>] [-l NoTestRun|RunLocalTests|RunAllTestsInOrg] [-r] [-m <array>] [-p <array>] [-f [-t | -c]] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:deploy [--soapdeploy] [-w <minutes>] [--purgeondelete -x <filepath>] [-q <id> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g | -t] [-m <array>] [-p <array>] [--predestructivechanges <filepath> ] [--postdestructivechanges <filepath> ] [-f ] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:ignored:list [-p <filepath>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:manifest:create [-m <array>] [-p <array>] [-n <string> | -t pre|post|destroy|package] [-c <array> --fromorg <string>] [-o <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:open -f <filepath> [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:pull [-f] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:push [-f] [-w <minutes>] [-g] [-u <string>] [--apiversion <string>] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-f -t] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:status [-l | -r] [-u <string>] [--apiversion <string>] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:tracking:clear [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:source:tracking:reset [-r <integer>] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx force:mdapi:beta:convert -r <directory> [-d <directory>] [-p <array> | -x <string> | -m <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
convert metadata from the Metadata API format into the source format
USAGE
$ sfdx force:mdapi:beta:convert -r <directory> [-d <directory>] [-p <array> | -x <string> | -m <array>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --outputdir=outputdir the output directory to store the
source–formatted files
-m, --metadata=metadata comma-separated list of metadata
component names to convert
-p, --metadatapath=metadatapath comma-separated list of metadata
file paths to convert
-r, --rootdir=rootdir (required) the root directory
containing the Metadata
API–formatted metadata
-x, --manifest=manifest file path to manifest (package.xml)
of metadata types to convert.
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
Converts metadata retrieved via Metadata API into the source format used in Salesforce DX projects.
To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the
metadata format to the source format using "sfdx force:mdapi:convert".
To convert files from the source format back to the metadata format, so that you can deploy them using "sfdx
force:mdapi:deploy", run "sfdx force:source:convert".
EXAMPLES
$ sfdx force:mdapi:beta:convert -r path/to/metadata
$ sfdx force:mdapi:beta:convert -r path/to/metadata -d path/to/outputdir
See code: src/commands/force/mdapi/beta/convert.ts
sfdx force:mdapi:beta:deploy [-d <directory>] [-w <minutes>] [-q <id> | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g | -c] [-f <filepath>] [-s] [--soapdeploy] [--purgeondelete] [-u <string>] [--apiversion <string>] [--verbose] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
deploy metadata to an org using Metadata API
USAGE
$ sfdx force:mdapi:beta:deploy [-d <directory>] [-w <minutes>] [-q <id> | -l
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g | -c] [-f <filepath>] [-s]
[--soapdeploy] [--purgeondelete] [-u <string>] [--apiversion <string>] [--verbose] [--concise] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --checkonly validate deploy but don’t save to
the org
-d, --deploydir=deploydir root of directory tree of files to
deploy
-f, --zipfile=zipfile path to .zip file of metadata to
deploy
-g, --ignorewarnings whether a warning will allow a
deployment to complete successfully
-l, --testlevel=(NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg) [default: NoTestRun] deployment
testing level
-o, --ignoreerrors ignore any errors and do not roll
back deployment
-q, --validateddeployrequestid=validateddeployrequestid request ID of the validated
deployment to run a Quick Deploy
-r, --runtests=runtests [default: ] tests to run if
--testlevel RunSpecifiedTests
-s, --singlepackage Indicates that the zip file points
to a directory structure for a
single package
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 0 minutes] wait time for
command to finish in minutes
(default: 0)
--apiversion=apiversion override the api version used for
api requests made by this command
--concise omit success messages for smaller
JSON output
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--purgeondelete specify that deleted components in
the destructive changes manifest
file are immediately eligible for
deletion rather than being stored in
the Recycle Bin
--soapdeploy deploy metadata with SOAP API
instead of REST API
--verbose verbose output of deploy results
EXAMPLES
Return a job ID you can use to check the deploy status:
sfdx force:mdapi:beta:deploy -d some/path
Deploy and poll for 1000 minutes:
sfdx force:mdapi:beta:deploy -d some/path -w 1000
Deploy a ZIP file:
sfdx force:mdapi:beta:deploy -f stuff.zip
Validate a deployment so the ID can be used for a quick deploy:
sfdx force:mdapi:beta:deploy -d some/path -w 1000 -c --testlevel RunAllTestsInOrg
Quick deploy using a previously validated deployment:
sfdx force:mdapi:beta:deploy -q MyValidatedId
See code: src/commands/force/mdapi/beta/deploy.ts
sfdx force:mdapi:beta:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
check the status of a metadata deployment
USAGE
$ sfdx force:mdapi:beta:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose]
[--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --jobid=jobid job ID of the deployment to check;
required if you’ve never deployed
using Salesforce CLI; if not
specified, defaults to your most
recent CLI deployment
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 33 minutes] wait time for
command to finish in minutes
(default: 33)
--apiversion=apiversion override the api version used for
api requests made by this command
--concise omit success messages for smaller
JSON output
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose verbose output of deploy results
EXAMPLES
Check the status of the most recent deployment
sfdx force:mdapi:beta:deploy:report
Check the status of a deploy with job ID 1234 and wait for 10 minutes for the result:
sfdx force:mdapi:beta:deploy:report -i 1234 -w 10
See code: src/commands/force/mdapi/beta/deploy/report.ts
sfdx force:mdapi:beta:retrieve -r <directory> [-k <filepath> | -d <directory> | -p <array>] [-s] [-n <string>] [-z] [-w <minutes>] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
retrieve metadata from an org using Metadata API
USAGE
$ sfdx force:mdapi:beta:retrieve -r <directory> [-k <filepath> | -d <directory> | -p <array>] [-s] [-n <string>] [-z]
[-w <minutes>] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --apiversion=apiversion target API version for the retrieve
-d, --sourcedir=sourcedir source dir to use instead of the
default package dir in
sfdx-project.json
-k, --unpackaged=unpackaged file path of manifest of components
to retrieve
-n, --zipfilename=zipfilename file name to use for the retrieved
zip file
-p, --packagenames=packagenames a comma-separated list of packages
to retrieve
-r, --retrievetargetdir=retrievetargetdir (required) directory root for the
retrieved files
-s, --singlepackage indicates that the zip file points
to a directory structure for a
single package
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 1440 minutes] wait time
for command to finish in minutes
-z, --unzip extract all files from the retrieved
zip file
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose verbose output of retrieve result
DESCRIPTION
Uses Metadata API to retrieve a .zip of XML files that represent metadata from the targeted org. The default target
username is the admin user for the default scratch org. You can retrieve and deploy up to 10,000 files or 400 MB (39
MB compressed) at one time.
EXAMPLES
Retrieve metadata in the default project directory into the target directory:
sfdx force:mdapi:beta:retrieve -r path/to/retrieve/dir
Retrieve metadata defined in the specified manifest into the target directory:
sfdx force:mdapi:beta:retrieve -r path/to/retrieve/dir -k package.xml
Retrieve metadata defined by the specified directory, name the retrieved zipfile and extract all contents
sfdx force:mdapi:beta:retrieve -d path/to/apexClasses -r path/to/retrieve/dir --unzip --zipfilename apexClasses.zip
Enqueue a retrieve request but do not wait for the metadata to be retrieved:
sfdx force:mdapi:beta:retrieve -r path/to/retrieve/dir --wait 0
See code: src/commands/force/mdapi/beta/retrieve.ts
sfdx force:mdapi:beta:retrieve:report [-r <directory>] [-i <id>] [-n <string>] [-z] [-w <minutes>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
check the status of a metadata retrieval
USAGE
$ sfdx force:mdapi:beta:retrieve:report [-r <directory>] [-i <id>] [-n <string>] [-z] [-w <minutes>] [-u <string>]
[--apiversion <string>] [--verbose] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --jobid=jobid job ID of the retrieve you want to
check; defaults to your most recent
CLI retrieval if not specified
-n, --zipfilename=zipfilename file name to use for the retrieved
zip file
-r, --retrievetargetdir=retrievetargetdir directory root for the retrieved
files
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 1440 minutes] wait time
for command to finish in minutes
-z, --unzip extract all files from the retrieved
zip file
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose verbose output of retrieve result
DESCRIPTION
Specify the job ID and a target directory for the retrieve you want to check. You can also specify a wait time
(minutes) to check for updates to the retrieve status. If the retrieve was successful, the resulting zip file will be
saved to the location passed in with the retrieve target parameter.
EXAMPLES
Poll until the metadata is retrieved (or timeout is reached) using data from the last force:mdapi:retrieve command:
sfdx force:mdapi:beta:retrieve:report
Report the current status of the last retrieve command. If the retrieve is complete the zip file of metadata is
written to the target directoy:
sfdx force:mdapi:beta:retrieve:report -r path/to/retrieve/dir -w 0
Poll until the metadata is retrieved (or timeout is reached) using the provided RetrieveID, naming the zip file and
extracting all contents:
sfdx force:mdapi:beta:retrieve:report -i retrieveId -r path/to/retrieve/dir --unzip --zipfilename apexClasses.zip
See code: src/commands/force/mdapi/beta/retrieve/report.ts
sfdx force:mdapi:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
cancel a metadata deployment
USAGE
$ sfdx force:mdapi:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --jobid=jobid job ID of the deployment you want to
cancel; defaults to your most recent
CLI deployment if not specified
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 33 minutes] wait time for
command to finish in minutes
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
Use this command to cancel a specified asynchronous metadata deployment. You can also specify a wait time (in minutes)
to check for updates to the canceled deploy status.
EXAMPLES
Deploy a directory of files to the org
$ sfdx force:mdapi:deploy -d <directory>
Now cancel this deployment and wait two minutes
$ sfdx force:mdapi:deploy:cancel -w 2
If you have multiple deployments in progress and want to cancel a specific one, specify the job ID
$ sfdx force:mdapi:deploy:cancel -i <jobid>
Check the status of the cancel job
$ sfdx force:mdapi:deploy:report
See code: src/commands/force/mdapi/deploy/cancel.ts
sfdx force:mdapi:describemetadata [-f <filepath>] [-u <string>] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
display details about the metadata types enabled for your org
USAGE
$ sfdx force:mdapi:describemetadata [-f <filepath>] [-u <string>] [-a <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --apiversion=apiversion API version to use
-f, --resultfile=resultfile path to the file where results are
stored
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
Use this information to identify the syntax needed for a <name> element in package.xml. The most recent API version is
the default, or you can specify an older version.
The default target username is the admin user for the default scratch org. The username must have the Modify All Data
permission or the Modify Metadata permission (Beta). For more information about permissions, see Salesforce Help.
EXAMPLES
$ sfdx force:mdapi:describemetadata -a 43.0
$ sfdx force:mdapi:describemetadata -u [email protected]
$ sfdx force:mdapi:describemetadata -f /path/to/outputfilename.txt
$ sfdx force:mdapi:describemetadata -u [email protected] -f /path/to/outputfilename.txt
See code: src/commands/force/mdapi/describemetadata.ts
sfdx force:mdapi:listmetadata -m <string> [-f <filepath>] [--folder <string>] [-u <string>] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
display properties of metadata components of a specified type
USAGE
$ sfdx force:mdapi:listmetadata -m <string> [-f <filepath>] [--folder <string>] [-u <string>] [-a <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --apiversion=apiversion API version to use
-f, --resultfile=resultfile path to the file where results are
stored
-m, --metadatatype=metadatatype (required) metadata type to be
retrieved, such as CustomObject;
metadata type value is
case-sensitive
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--folder=folder folder associated with the
component; required for components
that use folders; folder names are
case-sensitive
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
This command is useful when you want to identify individual components in your manifest file or if you want a
high-level view of particular components in your organization. For example, you could use this target to return a list
of names of all Layout components in your org, then use this information in a retrieve operation that returns a
subset of these components.
EXAMPLES
$ sfdx force:mdapi:listmetadata -m CustomObject
$ sfdx force:mdapi:listmetadata -m CustomObject -a 43.0
$ sfdx force:mdapi:listmetadata -m CustomObject -u [email protected]
$ sfdx force:mdapi:listmetadata -m CustomObject -f /path/to/outputfilename.txt
$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername
$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -a 43.0
$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -u [email protected]
$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -f /path/to/outputfilename.txt
$ sfdx force:mdapi:listmetadata -m CustomObject -u [email protected] -f /path/to/outputfilename.txt
See code: src/commands/force/mdapi/listmetadata.ts
sfdx force:source:convert [-r <directory>] [-d <directory>] [-n <string>] [-p <array> | -x <string> | -m <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
convert source into Metadata API format
USAGE
$ sfdx force:source:convert [-r <directory>] [-d <directory>] [-n <string>] [-p <array> | -x <string> | -m <array>]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --outputdir=outputdir [default:
metadataPackage_1646177166390]
output directory to store the
Metadata API–formatted files in
-m, --metadata=metadata comma-separated list of metadata
component names to convert
-n, --packagename=packagename name of the package to associate
with the metadata-formatted files
-p, --sourcepath=sourcepath comma-separated list of paths to the
local source files to convert
-r, --rootdir=rootdir a source directory other than the
default package to convert
-x, --manifest=manifest file path to manifest (package.xml)
of metadata types to convert.
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
Converts source-formatted files into metadata that you can deploy using Metadata API.
To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API,
run "sfdx force:source:convert". Then deploy the metadata using "sfdx force:mdapi:deploy".
To convert Metadata API–formatted files into the source format, run "sfdx force:mdapi:convert".
To specify a package name that includes spaces, enclose the name in single quotes.
EXAMPLES
$ sfdx force:source:convert -r path/to/source
$ sfdx force:source:convert -r path/to/source -d path/to/outputdir -n 'My Package'
See code: src/commands/force/source/convert.ts
sfdx force:source:delete [-w <minutes>] [-l NoTestRun|RunLocalTests|RunAllTestsInOrg] [-r] [-m <array>] [-p <array>] [-f [-t | -c]] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
delete source from your project and from a non-source-tracked org
USAGE
$ sfdx force:source:delete [-w <minutes>] [-l NoTestRun|RunLocalTests|RunAllTestsInOrg] [-r] [-m <array>] [-p <array>]
[-f [-t | -c]] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --checkonly validate delete command but do not
delete from the org or delete files
locally
-f, --forceoverwrite ignore conflict warnings and
overwrite changes to the org
-l, --testlevel=(NoTestRun|RunLocalTests|RunAllTestsInOrg) [default: NoTestRun] deployment
testing level
-m, --metadata=metadata comma-separated list of names of
metadata components to delete
-p, --sourcepath=sourcepath comma-separated list of source file
paths to delete
-r, --noprompt do not prompt for delete
confirmation
-t, --tracksource If the delete succeeds, update the
source tracking information, similar
to push
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 33 minutes] wait time for
command to finish in minutes
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose verbose output of delete result
DESCRIPTION
IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained
certain terms to avoid any effect on customer implementations.
Use this command to delete components from orgs that don’t have source tracking.
To remove deleted items from scratch orgs, which have change tracking, use "sfdx force:source:push".
EXAMPLES
$ sfdx force:source:delete -m <metadata>
$ sfdx force:source:delete -p path/to/source
See code: src/commands/force/source/delete.ts
sfdx force:source:deploy [--soapdeploy] [-w <minutes>] [--purgeondelete -x <filepath>] [-q <id> | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g | -t] [-m <array>] [-p <array>] [--predestructivechanges <filepath> ] [--postdestructivechanges <filepath> ] [-f ] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
deploy source to an org
USAGE
$ sfdx force:source:deploy [--soapdeploy] [-w <minutes>] [--purgeondelete -x <filepath>] [-q <id> | -c | -l
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r <array> | -o | -g | -t] [-m <array>] [-p <array>]
[--predestructivechanges <filepath> ] [--postdestructivechanges <filepath> ] [-f ] [-u <string>] [--apiversion
<string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --checkonly
validate deploy but don’t save to the org
-f, --forceoverwrite
ignore conflict warnings and overwrite changes to the org
-g, --ignorewarnings
whether a warning will allow a deployment to complete successfully
-l, --testlevel=(NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg)
[default: NoTestRun] deployment testing level
-m, --metadata=metadata
comma-separated list of metadata component names
-o, --ignoreerrors
ignore any errors and do not roll back deployment
-p, --sourcepath=sourcepath
comma-separated list of source file paths to deploy
-q, --validateddeployrequestid=validateddeployrequestid
deploy request ID of the validated deployment to run a Quick Deploy
-r, --runtests=runtests
[default: ] tests to run if --testlevel RunSpecifiedTests
-t, --tracksource
if the deploy succeeds, update source tracking information; doesn't delete locally deleted files from org unless you
also specify --predestructivechanges or --postdestructivechanges
-u, --targetusername=targetusername
username or alias for the target org; overrides default target org
-w, --wait=wait
[default: 33 minutes] wait time for command to finish in minutes
-x, --manifest=manifest
file path for manifest (package.xml) of components to deploy
--apiversion=apiversion
override the api version used for api requests made by this command
--json
format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
[default: warn] logging level for this command invocation
--postdestructivechanges=postdestructivechanges
file path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy
--predestructivechanges=predestructivechanges
file path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy
--purgeondelete
specify that deleted components in the destructive changes manifest file are immediately eligible for deletion
rather than being stored in the Recycle Bin
--soapdeploy
deploy metadata with SOAP API instead of REST API
--verbose
verbose output of deploy result
DESCRIPTION
IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained
certain terms to avoid any effect on customer implementations.
Use this command to deploy source (metadata that’s in source format) to an org.
To take advantage of change tracking with scratch orgs, use "sfdx force:source:push".
To deploy metadata that’s in metadata format, use "sfdx force:mdapi:deploy".
The source you deploy overwrites the corresponding metadata in your org. This command does not attempt to merge your
source with the versions in your org.
To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue
to use the CLI.
To check the status of the job, use force:source:deploy:report.
If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of
double quotes. On Windows, if the list contains commas, also enclose the entire list in one set of double quotes.
If you use the --manifest, --predestructivechanges, or --postdestructivechanges parameters, run the
force:source:manifest:create command to easily generate the different types of manifest files.
EXAMPLES
To deploy the source files in a directory:
$ sfdx force:source:deploy -p path/to/source
To deploy a specific Apex class and the objects whose source is in a directory:
$ sfdx force:source:deploy -p "path/to/apex/classes/MyClass.cls,path/to/source/objects"
To deploy source files in a comma-separated list that contains spaces:
$ sfdx force:source:deploy -p "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, path/to/apex/classes"
To deploy all Apex classes:
$ sfdx force:source:deploy -m ApexClass
To deploy a specific Apex class:
$ sfdx force:source:deploy -m ApexClass:MyApexClass
To deploy a specific Apex class and update source tracking files :
$ sfdx force:source:deploy -m ApexClass:MyApexClass --tracksource
To deploy all custom objects and Apex classes:
$ sfdx force:source:deploy -m "CustomObject,ApexClass"
To deploy all Apex classes and two specific profiles (one of which has a space in its name):
$ sfdx force:source:deploy -m "ApexClass, Profile:My Profile, Profile: AnotherProfile"
To deploy all components listed in a manifest:
$ sfdx force:source:deploy -x path/to/package.xml
To run the tests that aren’t in any managed packages as part of a deployment:
$ sfdx force:source:deploy -m ApexClass -l RunLocalTests
To check whether a deployment would succeed (to prepare for Quick Deploy):
$ sfdx force:source:deploy -m ApexClass -l RunAllTestsInOrg -c
To deploy an already validated deployment (Quick Deploy):
$ sfdx force:source:deploy -q 0Af9A00000FTM6pSAH`
To run a destructive operation before the deploy occurs:
$ sfdx force:source:deploy --manifest package.xml --predestructivechanges destructiveChangesPre.xml
To run a destructive operation after the deploy occurs:
$ sfdx force:source:deploy --manifest package.xml --postdestructivechanges destructiveChangesPost.xml
See code: src/commands/force/source/deploy.ts
sfdx force:source:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
cancel a source deployment
USAGE
$ sfdx force:source:deploy:cancel [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --jobid=jobid job ID of the deployment you want to
cancel; defaults to your most recent
CLI deployment if not specified
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 33 minutes] wait time for
command to finish in minutes
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
Use this command to cancel a specified asynchronous source deployment. You can also specify a wait time (in minutes)
to check for updates to the canceled deploy status.
To run the command asynchronously, set --wait to 0, which immediately returns the job ID. This way, you can continue
to use the CLI.
To check the status of the job, use force:source:deploy:report.
EXAMPLES
Deploy a directory of files to the org
$ sfdx force:source:deploy -d <directory>
Now cancel this deployment and wait two minutes
$ sfdx force:source:deploy:cancel -w 2
If you have multiple deployments in progress and want to cancel a specific one, specify the job ID
$ sfdx force:source:deploy:cancel -i <jobid>
Check the status of the cancel job
$ sfdx force:source:deploy:report
See code: src/commands/force/source/deploy/cancel.ts
sfdx force:source:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
check the status of a metadata deployment
USAGE
$ sfdx force:source:deploy:report [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --jobid=jobid job ID of the deployment you want to
check; defaults to your most recent
CLI deployment if not specified
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 33 minutes] wait time for
command to finish in minutes
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose verbose output of deploy result
DESCRIPTION
Specify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates
to the deploy status.
EXAMPLES
Deploy a directory of files to the org
$ sfdx force:source:deploy -d <directory>
Now cancel this deployment and wait two minutes
$ sfdx force:source:deploy:cancel -w 2
If you have multiple deployments in progress and want to cancel a specific one, specify the job ID
$ sfdx force:source:deploy:cancel -i <jobid>
Check the status of the cancel job
$ sfdx force:source:deploy:report
See code: src/commands/force/source/deploy/report.ts
sfdx force:source:ignored:list [-p <filepath>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
check your local project package directories for forceignored files
USAGE
$ sfdx force:source:ignored:list [-p <filepath>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-p, --sourcepath=sourcepath file or directory of files that the
command checks for foreceignored
files
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
See code: src/commands/force/source/ignored/list.ts
sfdx force:source:manifest:create [-m <array>] [-p <array>] [-n <string> | -t pre|post|destroy|package] [-c <array> --fromorg <string>] [-o <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
create a project manifest that lists the metadata components you want to deploy or retrieve
USAGE
$ sfdx force:source:manifest:create [-m <array>] [-p <array>] [-n <string> | -t pre|post|destroy|package] [-c <array>
--fromorg <string>] [-o <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --includepackages=includepackages comma-separated list of package
types (managed, unlocked) whose
metadata is included in the
manifest; by default, metadata in
packages is ignored
-m, --metadata=metadata comma-separated list of names of
metadata components to include in
the manifest
-n, --manifestname=manifestname name of a custom manifest file to
create
-o, --outputdir=outputdir directory to save the created
manifest
-p, --sourcepath=sourcepath comma-separated list of paths to the
local source files to include in the
manifest
-t, --manifesttype=(pre|post|destroy|package) type of manifest to create; the type
determines the name of the created
file
--apiversion=apiversion override the api version used for
api requests made by this command
--fromorg=fromorg username or alias of the org that
contains the metadata components
from which to build a manifest
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain
source files (--sourcepath). You can specify either of these parameters, not both.
Use --manifesttype to specify the type of manifest you want to create. The resulting manifest files have specific
names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter,
and their respective file names, are:
package : package.xml (default)
pre : destructiveChangesPre.xml
post : destructiveChangesPost.xml
destroy : destructiveChanges.xml
See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for
information about these destructive manifest files.
Use --manifestname to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs.
You can specify either --manifesttype or --manifestname, but not both.
EXAMPLES
$ sfdx force:source:manifest:create -m ApexClass
$ sfdx force:source:manifest:create -m ApexClass:MyApexClass --manifesttype destroy
$ sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest
$ sfdx force:source:manifest:create --fromorg [email protected] --includepackages unlocked
See code: src/commands/force/source/manifest/create.ts
sfdx force:source:open -f <filepath> [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
edit a Lightning Page with Lightning App Builder
USAGE
$ sfdx force:source:open -f <filepath> [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --sourcefile=sourcefile (required) file to edit
-r, --urlonly generate a navigation URL; don’t
launch the editor
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
Opens the specified Lightning Page in Lightning App Builder. Lightning Page files have the suffix .flexipage-meta.xml,
and are stored in the flexipages directory.
If you specify a Visualforce page, which has a .page suffix, the page opens in your browser so you can preview it. If
you specify a different type of file, this command opens your org’s home page.
The file opens in your default browser.
If no browser-based editor is available for the selected file, this command opens your org's home page.
To generate a URL for the browser-based editor but not open the editor, use --urlonly.
EXAMPLES
$ sfdx force:source:open -f path/to/source
$ sfdx force:source:open -r -f path/to/source
$ sfdx force:source:open -f path/to/source -u [email protected]
See code: src/commands/force/source/open.ts
sfdx force:source:pull [-f] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
pull source from the scratch org to the project
USAGE
$ sfdx force:source:pull [-f] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --forceoverwrite
ignore conflict warnings and overwrite changes to the project
-u, --targetusername=targetusername
username or alias for the target org; overrides default target org
-w, --wait=wait
[default: 33 minutes] The number of minutes to wait for the command to complete and display results to the terminal
window. If the command continues to run after the wait period, the CLI returns control of the terminal window to
you. The default is 33 minutes.
--apiversion=apiversion
override the api version used for api requests made by this command
--json
format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
[default: warn] logging level for this command invocation
ALIASES
$ sfdx force:source:beta:pull
See code: src/commands/force/source/pull.ts
sfdx force:source:push [-f] [-w <minutes>] [-g] [-u <string>] [--apiversion <string>] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
push source to a scratch org from the project
USAGE
$ sfdx force:source:push [-f] [-w <minutes>] [-g] [-u <string>] [--apiversion <string>] [--quiet] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --forceoverwrite
ignore conflict warnings and overwrite changes to scratch org
-g, --ignorewarnings
deploy changes even if warnings are generated
-u, --targetusername=targetusername
username or alias for the target org; overrides default target org
-w, --wait=wait
[default: 33 minutes] Number of minutes to wait for the command to complete and display results to the terminal
window. If the command continues to run after the wait period, the CLI returns control of the terminal window to
you. The default is 33 minutes.
--apiversion=apiversion
override the api version used for api requests made by this command
--json
format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
[default: warn] logging level for this command invocation
--quiet
minimize json and sdtout output on success
ALIASES
$ sfdx force:source:beta:push
See code: src/commands/force/source/push.ts
sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-f -t] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
retrieve source from an org
USAGE
$ sfdx force:source:retrieve [-p <array> | -x <filepath> | -m <array>] [-w <minutes>] [-n <array>] [-f -t] [-u
<string>] [-a <string>] [--verbose] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --apiversion=apiversion override the api version used for
api requests made by this command
-f, --forceoverwrite ignore conflict warnings and
overwrite changes to the project
-m, --metadata=metadata comma-separated list of metadata
component names
-n, --packagenames=packagenames a comma-separated list of packages
to retrieve
-p, --sourcepath=sourcepath comma-separated list of source file
paths to retrieve
-t, --tracksource if the retrieve succeeds, update
source tracking information; doesn't
delete local files that were deleted
in the org
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 33 minutes] wait time for
command to finish in minutes
-x, --manifest=manifest file path for manifest (package.xml)
of components to retrieve
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose verbose output of retrieve result
DESCRIPTION
Use this command to retrieve source (metadata that’s in source format) from an org.
To take advantage of change tracking with scratch orgs, use "sfdx force:source:pull".
To retrieve metadata that’s in metadata format, use "sfdx force:mdapi:retrieve".
The source you retrieve overwrites the corresponding source files in your local project. This command does not attempt
to merge the source from your org with your local source files.
If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of
double quotes. On Windows, if the list contains commas, also enclose it in one set of double quotes.
EXAMPLES
To retrieve the source files in a directory:
$ sfdx force:source:retrieve -p path/to/source
To retrieve a specific Apex class and the objects whose source is in a directory:
$ sfdx force:source:retrieve -p "path/to/apex/classes/MyClass.cls,path/to/source/objects"
To retrieve source files in a comma-separated list that contains spaces:
$ sfdx force:source:retrieve -p "path/to/objects/MyCustomObject/fields/MyField.field-meta.xml,
path/to/apex/classes"
To retrieve all Apex classes:
$ sfdx force:source:retrieve -m ApexClass
To retrieve a specific Apex class:
$ sfdx force:source:retrieve -m ApexClass:MyApexClass
To retrieve a specific Apex class and update source tracking files:
$ sfdx force:source:retrieve -m ApexClass:MyApexClass -t
To retrieve all custom objects and Apex classes:
$ sfdx force:source:retrieve -m "CustomObject,ApexClass"
To retrieve all Apex classes and two specific profiles (one of which has a space in its name):
$ sfdx force:source:retrieve -m "ApexClass, Profile:My Profile, Profile: AnotherProfile"
To retrieve all metadata components listed in a manifest:
$ sfdx force:source:retrieve -x path/to/package.xml
To retrieve metadata from a package or multiple packages:
$ sfdx force:source:retrieve -n MyPackageName
$ sfdx force:source:retrieve -n "Package1, PackageName With Spaces, Package3"
To retrieve all metadata from a package and specific components that aren’t in the package, specify both -n |
--packagenames and one other scoping parameter:
$ sfdx force:source:retrieve -n MyPackageName -p path/to/apex/classes
$ sfdx force:source:retrieve -n MyPackageName -m ApexClass:MyApexClass
$ sfdx force:source:retrieve -n MyPackageName -x path/to/package.xml
See code: src/commands/force/source/retrieve.ts
sfdx force:source:status [-l | -r] [-u <string>] [--apiversion <string>] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
list local changes and/or changes in a scratch org
USAGE
$ sfdx force:source:status [-l | -r] [-u <string>] [--apiversion <string>] [--concise] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-l, --local list the changes that have been made
locally
-r, --remote list the changes that have been made
in the scratch org
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--concise show only the changes that will be
pushed or pulled; omits files that
are forceignored
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
ALIASES
$ sfdx force:source:beta:status
EXAMPLES
sfdx force:source:status -l
sfdx force:source:status -r
sfdx force:source:status -a
sfdx force:source:status -a -u [email protected] --json
See code: src/commands/force/source/status.ts
sfdx force:source:tracking:clear [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
clear all local source tracking information
USAGE
$ sfdx force:source:tracking:clear [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-p, --noprompt do not prompt for source tracking
override confirmation
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.
Clears all local source tracking information. When you next run force:source:status, the CLI displays all local and
remote files as changed, and any files with the same name are listed as conflicts.
ALIASES
$ sfdx force:source:beta:tracking:clear
See code: src/commands/force/source/tracking/clear.ts
sfdx force:source:tracking:reset [-r <integer>] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
reset local and remote source tracking
USAGE
$ sfdx force:source:tracking:reset [-r <integer>] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-p, --noprompt do not prompt for source tracking
override confirmation
-r, --revision=revision reset to a specific SourceMember
revision counter number
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.
Resets local and remote source tracking so that the CLI no longer registers differences between your local files and
those in the org. When you next run force:source:status, the CLI returns no results, even though conflicts might
actually exist. The CLI then resumes tracking new source changes as usual.
Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get
the revision number, query the SourceMember Tooling API object with the force:data:soql:query command. For example:
$ sfdx force:data:soql:query -q "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" -t
ALIASES
$ sfdx force:source:beta:tracking:reset