This page describes an older version of Prodly SF CLI. View Latest
appops:manage
To authorize (or unauthorize) a Salesforce environment (not already added to the Environments page in Release tab) for use by the plugin, enter this command at the command line prompt in your Salesforce DX CLI command shell:
$ sfdx appops:manage INSTRUCTIONS [ENVIRONMENTS] [OPTIONS]
This table lists all the available options:
Options | Purpose |
---|---|
-b <nickname>, –label=<nickname> | Use to specify a nickname for the environment. |
-c <comment>, –comment=<comment> | Use to include a VCS commit message. |
-i <environment>, –instance=<environment> | Use to specify the Salesforce environment ID on which to perform the action. |
-l, –list | Use to see the list of all environments added via this plugin and/or the Release UI. |
-m, –manage | Use to make the Salesforce environment available to Release and the other DX plugin commands. |
-n <connection>, –connection=<connection> | Use to specify the connection record to use to access the Salesforce environment. |
-p, | Use to see a standardized-format list of all environments added via this plugin and/or the Release UI. |
-s, –version | Use to create a VCS repository branch, merge data from main into it, and deploy the data to the Salesforce environment. |
-u <username>, –targetusername=<username> | Use to specify the username or alias of the destination environment, overriding any default scratch org you specified in the optional setup steps. |
-v <username>, –targetdevhubusername=<username> | Use to specify the username or alias of the dev hub org, overriding any dev hub org you specified in the optional setup steps. |
-x, –unmanage | Use to make the Salesforce environment unavailable to Release and the other DX plugin commands. |
–apiversion=<apiversion> | Use to override the API version used for API requests made by this command. |
–json | Use to receive an output response. When included, the response is in JSON format. When not included, no response is given. |
–loglevel=<level> | Use to specify the logging level for this command invocation with one of these levels:errorwarninfodebugtracefatalFor details, refer to https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_log_messages.htm. |
Response
When you include –json in your appops:deploy command, you receive the following output when the deployment initiates:
{
“Deployment launched with Job ID: “<JobID>”
}
Examples
Command | Result |
---|---|
$ sfdx appops:deploy -p MyDeploymentPlan | Uses a deployment plan to deploy data to the default scratch org from the default dev hub org. |
$ sfdx appops:deploy -t MyDataSet -u FixesScratchOrg -v MainDevHub | Uses a data set to deploy data to a specified scratch org from a specified dev hub org. |
$ sfdx appops:deploy –dataset=MyDataSet –targetusername=test-utxac7gbati9@example.com –targetdevhubusername=jsmith@acme.com | Uses a data set to deploy data to a specified scratch org from a specified dev hub org using long parameter names. |
$ sfdx appops:deploy -t MyDataSet -d “UAT Sandbox Connection” | Uses a data set to deploy data to a specified UAT sandbox org from the default scratch org using the named connection record. |
$ sfdx appops:deploy –plan=MyDeploymentPlan –targetusername=test-utxac7gbati9@example.com –source “Production Connection” | Uses a deployment plan to deploy data to a specified scratch org from the production org using the named connection record and long parameter names. |