Skip to content

Commit

Permalink
Update messages so examples render correctly in CLI Ref (#489)
Browse files Browse the repository at this point in the history
* fix: update messages so examples render correctly in CLI Ref

* add prompt to examples

* update examples

* update examples
  • Loading branch information
jshackell-sfdc authored May 18, 2022
1 parent fbf8368 commit 45f0635
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
10 changes: 5 additions & 5 deletions messages/md.deploy.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
"description": "deploy metadata to an org using Metadata API",
"examples": [
"Return a job ID you can use to check the deploy status:",
" sfdx force:mdapi:deploy -d some/path",
"$ sfdx force:mdapi:deploy -d some/path",
"Deploy and poll for 1000 minutes:",
" sfdx force:mdapi:deploy -d some/path -w 1000",
"$ sfdx force:mdapi:deploy -d some/path -w 1000",
"Deploy a ZIP file:",
" sfdx force:mdapi:deploy -f stuff.zip",
"$ sfdx force:mdapi:deploy -f stuff.zip",
"Validate a deployment so the ID can be used for a quick deploy:",
" sfdx force:mdapi:deploy -d some/path -w 1000 -c --testlevel RunAllTestsInOrg",
"$ sfdx force:mdapi:deploy -d some/path -w 1000 -c --testlevel RunAllTestsInOrg",
"Quick deploy using a previously validated deployment:",
" sfdx force:mdapi:deploy -q MyValidatedId"
"$ sfdx force:mdapi:deploy -q MyValidatedId"
],
"flags": {
"checkOnly": "validate deploy but don’t save to the org",
Expand Down
4 changes: 2 additions & 2 deletions messages/md.deployreport.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"mdDeployReportCommandCliHelp": "Specify the job ID for the deploy you want to check. The job ID is returned by the force:mdapi:deploy command when run without the --wait parameter. You can also specify a wait time (minutes) to check for updates to the deploy status.",
"examples": [
"Check the status of the most recent deployment",
" sfdx force:mdapi:deploy:report",
"$ sfdx force:mdapi:deploy:report",
"Check the status of a deploy with job ID 1234 and wait for 10 minutes for the result:",
" sfdx force:mdapi:deploy:report -i 1234 -w 10"
"$ sfdx force:mdapi:deploy:report -i 1234 -w 10"
],
"flags": {
"verbose": "verbose output of deploy results",
Expand Down
8 changes: 4 additions & 4 deletions messages/md.retrieve.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"description": "retrieve metadata from an org using Metadata API\nUses 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:retrieve -r path/to/retrieve/dir",
"$ sfdx force:mdapi:retrieve -r path/to/retrieve/dir",
"Retrieve metadata defined in the specified manifest into the target directory:",
" sfdx force:mdapi:retrieve -r path/to/retrieve/dir -k package.xml",
"$ sfdx force:mdapi: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:retrieve -d path/to/apexClasses -r path/to/retrieve/dir --unzip --zipfilename apexClasses.zip",
"$ sfdx force:mdapi: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:retrieve -r path/to/retrieve/dir --wait 0"
"$ sfdx force:mdapi:retrieve -r path/to/retrieve/dir --wait 0"
]
},
"reportCmd": {
Expand Down
8 changes: 4 additions & 4 deletions messages/status.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
"description": "list local changes and/or changes in a scratch org",
"LongDescription": "Lists changes that have been made locally, in a scratch org, or both.",
"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"
"$ sfdx force:source:status -l",
"$ sfdx force:source:status -r",
"$ sfdx force:source:status -a",
"$ sfdx force:source:status -a -u [email protected] --json"
],
"flags": {
"all": "list all the changes that have been made",
Expand Down

0 comments on commit 45f0635

Please sign in to comment.