From 50b62c89e27514716fd1de35fb0a720a7d6054a4 Mon Sep 17 00:00:00 2001 From: SF-CLI-BOT Date: Thu, 13 Jan 2022 18:43:56 +0000 Subject: [PATCH] chore(release): 1.8.0 [ci skip] --- CHANGELOG.md | 12 ++ README.md | 330 +++++++++++++++++++++++++++++++++++++++++++++------ 2 files changed, 308 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 420036a85..a0c185d72 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,18 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [1.8.0](https://github.com/salesforcecli/plugin-source/compare/v1.6.2...v1.8.0) (2022-01-13) + +### Features + +- concise flag on status to omit ignored files ([#382](https://github.com/salesforcecli/plugin-source/issues/382)) ([2dcbac8](https://github.com/salesforcecli/plugin-source/commit/2dcbac81e57d056e82835c785bc5a5dc98a255a4)) +- mdapi deploy/report commands ([8068ff0](https://github.com/salesforcecli/plugin-source/commit/8068ff07213541a5823d5908bc831f92e89aa122)) + +### Bug Fixes + +- add variable polling times based on comp. set ([#360](https://github.com/salesforcecli/plugin-source/issues/360)) ([4a839ff](https://github.com/salesforcecli/plugin-source/commit/4a839ff7f9f429a723c54baf6c9cb65139eadf43)) +- update --testlevel RunLocalTests --help to say that unlocked packages are also excluded ([#384](https://github.com/salesforcecli/plugin-source/issues/384)) ([5f0ad44](https://github.com/salesforcecli/plugin-source/commit/5f0ad449a6880d761a233c3191e3759a6c0b72cc)) + ### [1.6.2](https://github.com/salesforcecli/plugin-source/compare/v1.6.1...v1.6.2) (2021-12-03) ### Bug Fixes diff --git a/README.md b/README.md index bc2a3f24b..b239ced51 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ $ npm install -g @salesforce/plugin-source $ sfdx COMMAND running command... $ sfdx (-v|--version|version) -@salesforce/plugin-source/1.6.1 linux-x64 node-v12.22.7 +@salesforce/plugin-source/1.8.0 linux-x64 node-v12.22.9 $ sfdx --help [COMMAND] USAGE $ sfdx COMMAND @@ -97,20 +97,24 @@ USAGE - [`sfdx force:mdapi:beta:convert -r [-d ] [-p | -x | -m ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapibetaconvert--r-directory--d-directory--p-array---x-string---m-array---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +- [`sfdx force:mdapi:beta:deploy [-d ] [-w ] [-q | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g | -c] [-f ] [-s] [--soapdeploy] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapibetadeploy--d-directory--w-minutes--q-id---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r-array---o---g---c--f-filepath--s---soapdeploy--u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +- [`sfdx force:mdapi:beta:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapibetadeployreport--w-minutes--i-id--u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +- [`sfdx force:mdapi:beta:retrieve -r [-k | -d | -p ] [-s] [-f ] [-z] [-w ] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapibetaretrieve--r-directory--k-filepath---d-directory---p-array--s--f-string--z--w-minutes--u-string--a-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +- [`sfdx force:mdapi:beta:retrieve:report [-r ] [-i ] [-n ] [-z] [-w ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapibetaretrievereport--r-directory--i-id--n-string--z--w-minutes--u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:mdapi:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapideploycancel--w-minutes--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:mdapi:describemetadata [-f ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapidescribemetadata--f-filepath--u-string--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:mdapi:listmetadata -m [-f ] [--folder ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcemdapilistmetadata--m-string--f-filepath---folder-string--u-string--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:source:beta:pull [-f] [-w ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetapull--f--w-minutes--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:source:beta:push [-f] [-w ] [-g] [-u ] [--apiversion ] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetapush--f--w-minutes--g--u-string---apiversion-string---quiet---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetastatus--l---r--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +- [`sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetastatus--l---r--u-string---apiversion-string---concise---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:source:beta:tracking:clear [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetatrackingclear--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:source:beta:tracking:reset [-r ] [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcebetatrackingreset--r-integer--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:source:convert [-r ] [-d ] [-n ] [-p | -x | -m ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourceconvert--r-directory--d-directory--n-string--p-array---x-string---m-array---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx `](#sfdx-) -- [`sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -x | -m | -p | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [--predestructivechanges ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeploy---soapdeploy--w-minutes--q-id---x-filepath---m-array---p-array---c---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r-array---o---g---predestructivechanges-filepath----postdestructivechanges-filepath---u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +- [`sfdx force:source:delete [-c] [-w ] [-l NoTestRun|RunLocalTests|RunAllTestsInOrg] [-r] [-m ] [-p ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedelete--c--w-minutes--l-notestrunrunlocaltestsrunalltestsinorg--r--m-array--p-array--u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +- [`sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [-m ] [-p ] [--predestructivechanges -x ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeploy---soapdeploy--w-minutes--q-id---c---l-notestrunrunspecifiedtestsrunlocaltestsrunalltestsinorg---r-array---o---g--m-array--p-array---predestructivechanges-filepath--x-filepath---postdestructivechanges-filepath---u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:source:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeploycancel--w-minutes--i-id--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:source:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcedeployreport--w-minutes--i-id--u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:source:manifest:create [-m | -p ] [-n | -t pre|post|destroy|package] [-o ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcemanifestcreate--m-array---p-array--n-string---t-prepostdestroypackage--o-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +- [`sfdx force:source:manifest:create [-m ] [-p ] [-n | -t pre|post|destroy|package] [-o ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourcemanifestcreate--m-array--p-array--n-string---t-prepostdestroypackage--o-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:source:open -f [-r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourceopen--f-filepath--r--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) - [`sfdx force:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcesourceretrieve--p-array---x-filepath---m-array--w-minutes--n-array--u-string--a-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) @@ -166,7 +170,259 @@ EXAMPLES $ sfdx force:mdapi:beta:convert -r path/to/metadata -d path/to/outputdir ``` -_See code: [src/commands/force/mdapi/beta/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/mdapi/beta/convert.ts)_ +_See code: [src/commands/force/mdapi/beta/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/mdapi/beta/convert.ts)_ + +## `sfdx force:mdapi:beta:deploy [-d ] [-w ] [-q | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g | -c] [-f ] [-s] [--soapdeploy] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +deploy metadata to an org using Metadata API + +``` +deploy metadata to an org using Metadata API + +USAGE + $ sfdx force:mdapi:beta:deploy [-d ] [-w ] [-q | -l + NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g | -c] [-f ] [-s] + [--soapdeploy] [-u ] [--apiversion ] [--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 + + -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 + + --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 + + --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](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/mdapi/beta/deploy.ts)_ + +## `sfdx force:mdapi:beta:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +check the status of a metadata deployment + +``` +check the status of a metadata deployment + +USAGE + $ sfdx force:mdapi:beta:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] + [--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 + + --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](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/mdapi/beta/deploy/report.ts)_ + +## `sfdx force:mdapi:beta:retrieve -r [-k | -d | -p ] [-s] [-f ] [-z] [-w ] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +retrieve metadata from an org using Metadata API + +``` +retrieve metadata from an org using Metadata API +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. + +USAGE + $ sfdx force:mdapi:beta:retrieve -r [-k | -d | -p ] [-s] [-f ] [-z] + [-w ] [-u ] [-a ] [--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 + + -f, --zipfilename=zipfilename file name to use for the retrieved + zip file + + -k, --unpackaged=unpackaged file path of manifest of components + to retrieve + + -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](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/mdapi/beta/retrieve.ts)_ + +## `sfdx force:mdapi:beta:retrieve:report [-r ] [-i ] [-n ] [-z] [-w ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` + +check the status of a metadata retrieval + +``` +check the status of a metadata retrieval +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. + +USAGE + $ sfdx force:mdapi:beta:retrieve:report [-r ] [-i ] [-n ] [-z] [-w ] [-u ] + [--apiversion ] [--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](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/mdapi/beta/retrieve/report.ts)_ ## `sfdx force:mdapi:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -214,7 +470,7 @@ EXAMPLES $ sfdx force:mdapi:deploy:report ``` -_See code: [src/commands/force/mdapi/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/mdapi/deploy/cancel.ts)_ +_See code: [src/commands/force/mdapi/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/mdapi/deploy/cancel.ts)_ ## `sfdx force:mdapi:describemetadata [-f ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -258,7 +514,7 @@ EXAMPLES $ sfdx force:mdapi:describemetadata -u me@example.com -f /path/to/outputfilename.txt ``` -_See code: [src/commands/force/mdapi/describemetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/mdapi/describemetadata.ts)_ +_See code: [src/commands/force/mdapi/describemetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/mdapi/describemetadata.ts)_ ## `sfdx force:mdapi:listmetadata -m [-f ] [--folder ] [-u ] [-a ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -314,7 +570,7 @@ EXAMPLES $ sfdx force:mdapi:listmetadata -m CustomObject -u me@example.com -f /path/to/outputfilename.txt ``` -_See code: [src/commands/force/mdapi/listmetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/mdapi/listmetadata.ts)_ +_See code: [src/commands/force/mdapi/listmetadata.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/mdapi/listmetadata.ts)_ ## `sfdx force:source:beta:pull [-f] [-w ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -349,7 +605,7 @@ OPTIONS [default: warn] logging level for this command invocation ``` -_See code: [src/commands/force/source/beta/pull.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/beta/pull.ts)_ +_See code: [src/commands/force/source/beta/pull.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/beta/pull.ts)_ ## `sfdx force:source:beta:push [-f] [-w ] [-g] [-u ] [--apiversion ] [--quiet] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -390,9 +646,9 @@ OPTIONS minimize json and sdtout output on success ``` -_See code: [src/commands/force/source/beta/push.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/beta/push.ts)_ +_See code: [src/commands/force/source/beta/push.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/beta/push.ts)_ -## `sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` +## `sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--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 @@ -400,7 +656,7 @@ list local changes and/or changes in a scratch org list local changes and/or changes in a scratch org USAGE - $ sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx force:source:beta:status [-l | -r] [-u ] [--apiversion ] [--concise] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS @@ -416,6 +672,10 @@ OPTIONS --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 @@ -428,7 +688,7 @@ EXAMPLES sfdx force:source:status -a -u me@example.com --json ``` -_See code: [src/commands/force/source/beta/status.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/beta/status.ts)_ +_See code: [src/commands/force/source/beta/status.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/beta/status.ts)_ ## `sfdx force:source:beta:tracking:clear [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -467,7 +727,7 @@ DESCRIPTION and remote files as changed, and any files with the same name are listed as conflicts. ``` -_See code: [src/commands/force/source/beta/tracking/clear.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/beta/tracking/clear.ts)_ +_See code: [src/commands/force/source/beta/tracking/clear.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/beta/tracking/clear.ts)_ ## `sfdx force:source:beta:tracking:reset [-r ] [-p] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -517,7 +777,7 @@ DESCRIPTION $ sfdx force:data:soql:query -q "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" -t ``` -_See code: [src/commands/force/source/beta/tracking/reset.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/beta/tracking/reset.ts)_ +_See code: [src/commands/force/source/beta/tracking/reset.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/beta/tracking/reset.ts)_ ## `sfdx force:source:convert [-r ] [-d ] [-n ] [-p | -x | -m ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -539,7 +799,7 @@ USAGE OPTIONS -d, --outputdir=outputdir [default: - metadataPackage_1638502964155] + metadataPackage_1642099433413] output directory to store the Metadata API–formatted files in @@ -577,9 +837,9 @@ EXAMPLES $ sfdx force:source:convert -r path/to/source -d path/to/outputdir -n 'My Package' ``` -_See code: [src/commands/force/source/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/convert.ts)_ +_See code: [src/commands/force/source/convert.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/convert.ts)_ -## `sfdx ` +## `sfdx force:source:delete [-c] [-w ] [-l NoTestRun|RunLocalTests|RunAllTestsInOrg] [-r] [-m ] [-p ] [-u ] [--apiversion ] [--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 @@ -591,7 +851,9 @@ Use this command to delete components from orgs that don’t have source trackin To remove deleted items from scratch orgs, which have change tracking, use "sfdx force:source:push". USAGE - $ sfdx force:source:delete + $ sfdx force:source:delete [-c] [-w ] [-l NoTestRun|RunLocalTests|RunAllTestsInOrg] [-r] [-m ] [-p + ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS -c, --checkonly validate delete command but do not @@ -638,9 +900,9 @@ EXAMPLES $ sfdx force:source:delete -p path/to/source ``` -_See code: [src/commands/force/source/delete.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/delete.ts)_ +_See code: [src/commands/force/source/delete.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/delete.ts)_ -## `sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -x | -m | -p | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [--predestructivechanges ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` +## `sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -c | -l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [-m ] [-p ] [--predestructivechanges -x ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` deploy source to an org @@ -661,10 +923,10 @@ If the comma-separated list you’re supplying contains spaces, enclose the enti 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. USAGE - $ sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -x | -m | -p | -c | -l - NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [--predestructivechanges - ] [--postdestructivechanges ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel - trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + $ sfdx force:source:deploy [--soapdeploy] [-w ] [-q | -c | -l + NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg | -r | -o | -g] [-m ] [-p ] + [--predestructivechanges -x ] [--postdestructivechanges ] [-u ] [--apiversion + ] [--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 @@ -772,7 +1034,7 @@ EXAMPLES $ sfdx force:source:deploy --manifest package.xml --postdestructivechanges destructiveChangesPost.xml ``` -_See code: [src/commands/force/source/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/deploy.ts)_ +_See code: [src/commands/force/source/deploy.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/deploy.ts)_ ## `sfdx force:source:deploy:cancel [-w ] [-i ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -827,7 +1089,7 @@ EXAMPLES $ sfdx force:source:deploy:report ``` -_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/deploy/cancel.ts)_ +_See code: [src/commands/force/source/deploy/cancel.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/deploy/cancel.ts)_ ## `sfdx force:source:deploy:report [-w ] [-i ] [-u ] [--apiversion ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -877,9 +1139,9 @@ EXAMPLES $ sfdx force:source:deploy:report ``` -_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/deploy/report.ts)_ +_See code: [src/commands/force/source/deploy/report.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/deploy/report.ts)_ -## `sfdx force:source:manifest:create [-m | -p ] [-n | -t pre|post|destroy|package] [-o ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` +## `sfdx force:source:manifest:create [-m ] [-p ] [-n | -t pre|post|destroy|package] [-o ] [--apiversion ] [--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 @@ -900,7 +1162,7 @@ Use --manifestname to specify a custom name for the generated manifest if the pr USAGE - $ sfdx force:source:manifest:create [-m | -p ] [-n | -t pre|post|destroy|package] [-o + $ sfdx force:source:manifest:create [-m ] [-p ] [-n | -t pre|post|destroy|package] [-o ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] @@ -956,7 +1218,7 @@ EXAMPLES $ sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest ``` -_See code: [src/commands/force/source/manifest/create.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/manifest/create.ts)_ +_See code: [src/commands/force/source/manifest/create.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/manifest/create.ts)_ ## `sfdx force:source:open -f [-r] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -1006,7 +1268,7 @@ EXAMPLES $ sfdx force:source:open -f path/to/source -u my-user@my-org.com ``` -_See code: [src/commands/force/source/open.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/open.ts)_ +_See code: [src/commands/force/source/open.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/open.ts)_ ## `sfdx force:source:retrieve [-p | -x | -m ] [-w ] [-n ] [-u ] [-a ] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -1094,6 +1356,6 @@ EXAMPLES $ sfdx force:source:retrieve -n MyPackageName -x path/to/package.xml ``` -_See code: [src/commands/force/source/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.6.1/src/commands/force/source/retrieve.ts)_ +_See code: [src/commands/force/source/retrieve.ts](https://github.com/salesforcecli/plugin-source/blob/v1.8.0/src/commands/force/source/retrieve.ts)_