generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a09c197
commit 031025b
Showing
3 changed files
with
54 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -86,8 +86,8 @@ Convert metadata retrieved via Metadata API into the source format used in Sales | |
|
||
``` | ||
USAGE | ||
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value> | | ||
-x <value> | -m <value>] | ||
$ sf project convert mdapi -r <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-p <value>... | ||
| -x <value> | -m <value>...] | ||
FLAGS | ||
-d, --output-dir=<value> Directory to store your files in after they’re converted to source format; can be an | ||
|
@@ -141,7 +141,7 @@ FLAG DESCRIPTIONS | |
If you specify this parameter, don’t specify --metadata or --source-dir. | ||
``` | ||
|
||
_See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/convert/mdapi.ts)_ | ||
_See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/convert/mdapi.ts)_ | ||
|
||
## `sf project convert source` | ||
|
||
|
@@ -150,10 +150,10 @@ Convert source-formatted files into metadata that you can deploy using Metadata | |
``` | ||
USAGE | ||
$ sf project convert source [--json] [--flags-dir <value>] [--api-version <value>] [-r <value>] [-d <value>] [-n <value>] | ||
[-p <value> | -x <value> | -m <value>] | ||
[-p <value>... | -x <value> | -m <value>...] | ||
FLAGS | ||
-d, --output-dir=<value> [default: metadataPackage_1717296443674] Output directory to store the Metadata | ||
-d, --output-dir=<value> [default: metadataPackage_1717649318884] Output directory to store the Metadata | ||
API–formatted files in. | ||
-m, --metadata=<value>... Metadata component names to convert. | ||
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files. | ||
|
@@ -214,7 +214,7 @@ FLAG DESCRIPTIONS | |
Override the api version used for api requests made by this command | ||
``` | ||
|
||
_See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/convert/source.ts)_ | ||
_See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/convert/source.ts)_ | ||
|
||
## `sf project convert source-behavior` | ||
|
||
|
@@ -271,7 +271,7 @@ EXAMPLES | |
$ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run --preserve-temp-dir | ||
``` | ||
|
||
_See code: [src/commands/project/convert/source-behavior.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/convert/source-behavior.ts)_ | ||
_See code: [src/commands/project/convert/source-behavior.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/convert/source-behavior.ts)_ | ||
|
||
## `sf project delete source` | ||
|
||
|
@@ -280,8 +280,8 @@ Delete source from your project and from a non-source-tracked org. | |
``` | ||
USAGE | ||
$ sf project delete source -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-w <value>] [--tests | ||
<value>] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>] [-p <value>] [-f [-t | | ||
-c]] [--verbose] | ||
<value>...] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r] [-m <value>...] [-p <value>...] [-f | ||
[-t | -c]] [--verbose] | ||
FLAGS | ||
-c, --check-only Validate delete command but don't delete anything from the org or the local project. | ||
|
@@ -411,7 +411,7 @@ FLAG DESCRIPTIONS | |
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space" | ||
``` | ||
|
||
_See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/delete/source.ts)_ | ||
_See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/delete/source.ts)_ | ||
|
||
## `sf project delete tracking` | ||
|
||
|
@@ -448,15 +448,15 @@ EXAMPLES | |
$ sf project delete tracking --target-org my-scratch | ||
``` | ||
|
||
_See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/delete/tracking.ts)_ | ||
_See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/delete/tracking.ts)_ | ||
|
||
## `sf project deploy cancel` | ||
|
||
Cancel a deploy operation. | ||
|
||
``` | ||
USAGE | ||
$ sf project deploy cancel [--json] [--flags-dir <value>] [-o <value>] [--async | -w <value>] [-i <value>] [-r] | ||
$ sf project deploy cancel [--json] [--flags-dir <value>] [-o <value>] [--async | -w <minutes>] [-i <value>] [-r] | ||
FLAGS | ||
-i, --job-id=<value> Job ID of the deploy operation you want to cancel. | ||
|
@@ -520,15 +520,15 @@ FLAG DESCRIPTIONS | |
project deploy report". | ||
``` | ||
|
||
_See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/deploy/cancel.ts)_ | ||
_See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/cancel.ts)_ | ||
|
||
## `sf project deploy preview` | ||
|
||
Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files. | ||
|
||
``` | ||
USAGE | ||
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value> | -m <value>] | ||
$ sf project deploy preview -o <value> [--json] [--flags-dir <value>] [-c] [-x <value> | -d <value>... | -m <value>...] | ||
[--concise] | ||
FLAGS | ||
|
@@ -603,16 +603,16 @@ FLAG DESCRIPTIONS | |
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir. | ||
``` | ||
|
||
_See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/deploy/preview.ts)_ | ||
_See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/preview.ts)_ | ||
|
||
## `sf project deploy quick` | ||
|
||
Quickly deploy a validated deployment to an org. | ||
|
||
``` | ||
USAGE | ||
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <value>] [--concise | --verbose] [-i <value>] [-o | ||
<value>] [-r] [-a <value>] | ||
$ sf project deploy quick [--json] [--flags-dir <value>] [--async | -w <minutes>] [--concise | --verbose] [-i <value>] | ||
[-o <value>] [-r] [-a <value>] | ||
FLAGS | ||
-a, --api-version=<value> Target API version for the deploy. | ||
|
@@ -645,7 +645,7 @@ DESCRIPTION | |
This command doesn’t attempt to merge your source with the versions in your org. | ||
Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, | ||
sandboxes don't run tests during a deploy. Use `sf project deploy start` instead. | ||
sandboxes don't run tests during a deploy. Use "sf project deploy start" instead. | ||
ALIASES | ||
$ sf deploy metadata quick | ||
|
@@ -687,7 +687,7 @@ FLAG DESCRIPTIONS | |
deploy report". | ||
``` | ||
|
||
_See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/deploy/quick.ts)_ | ||
_See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/quick.ts)_ | ||
|
||
## `sf project deploy report` | ||
|
||
|
@@ -696,8 +696,8 @@ Check or poll for the status of a deploy operation. | |
``` | ||
USAGE | ||
$ sf project deploy report [--json] [--flags-dir <value>] [-o <value>] [-i <value>] [-r] [--coverage-formatters | ||
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir | ||
<value>] [-w <value>] | ||
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...] [--junit] | ||
[--results-dir <value>] [-w <minutes>] | ||
FLAGS | ||
-i, --job-id=<value> Job ID of the deploy operation you want to check the status of. | ||
|
@@ -779,16 +779,16 @@ FLAG DESCRIPTIONS | |
--coverage-formatters lcov --coverage-formatters clover | ||
``` | ||
|
||
_See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/deploy/report.ts)_ | ||
_See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/report.ts)_ | ||
|
||
## `sf project deploy resume` | ||
|
||
Resume watching a deploy operation and update source tracking when the deploy completes. | ||
|
||
``` | ||
USAGE | ||
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <value>] | ||
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] | ||
$ sf project deploy resume [--json] [--flags-dir <value>] [--concise | --verbose] [-i <value>] [-r] [-w <minutes>] | ||
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...] | ||
[--junit] [--results-dir <value>] | ||
FLAGS | ||
|
@@ -864,19 +864,19 @@ FLAG DESCRIPTIONS | |
--coverage-formatters lcov --coverage-formatters clover | ||
``` | ||
|
||
_See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/deploy/resume.ts)_ | ||
_See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/resume.ts)_ | ||
|
||
## `sf project deploy start` | ||
|
||
Deploy metadata to an org from your local project. | ||
|
||
``` | ||
USAGE | ||
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <value>] [--concise | | ||
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value>] [-l | ||
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value> | -m <value> | ||
| --metadata-dir <value>]] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ] | ||
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] | ||
$ sf project deploy start -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async | -w <minutes>] [--concise | | ||
--verbose] [--dry-run] [-c] [-r] [-g] [--single-package ] [-t <value>...] [-l | ||
NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [--purge-on-delete [-x <value> | -d <value>... | -m | ||
<value>... | --metadata-dir <value>]] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ] | ||
[--coverage-formatters clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...] | ||
[--junit] [--results-dir <value>] | ||
FLAGS | ||
|
@@ -1090,7 +1090,7 @@ FLAG DESCRIPTIONS | |
--coverage-formatters lcov --coverage-formatters clover | ||
``` | ||
|
||
_See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/deploy/start.ts)_ | ||
_See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/start.ts)_ | ||
|
||
## `sf project deploy validate` | ||
|
||
|
@@ -1099,10 +1099,11 @@ Validate a metadata deployment without actually executing it. | |
``` | ||
USAGE | ||
$ sf project deploy validate -o <value> [--json] [--flags-dir <value>] [-a <value>] [--async] [--concise | --verbose] [-m | ||
<value>] [-d <value>] [--single-package --metadata-dir <value>] [-t <value>] [-l | ||
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <value>] [-g] [--coverage-formatters | ||
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary] [--junit] [--results-dir | ||
<value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ] [--post-destructive-changes <value> ] | ||
<value>...] [-d <value>...] [--single-package --metadata-dir <value>] [-t <value>...] [-l | ||
RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests] [-w <minutes>] [-g] [--coverage-formatters | ||
clover|cobertura|html-spa|html|json|json-summary|lcovonly|none|teamcity|text|text-summary...] [--junit] | ||
[--results-dir <value>] [--purge-on-delete -x <value>] [--pre-destructive-changes <value> ] | ||
[--post-destructive-changes <value> ] | ||
FLAGS | ||
-a, --api-version=<value> Target API version for the validation. | ||
|
@@ -1262,16 +1263,16 @@ FLAG DESCRIPTIONS | |
--coverage-formatters lcov --coverage-formatters clover | ||
``` | ||
|
||
_See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/deploy/validate.ts)_ | ||
_See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/deploy/validate.ts)_ | ||
|
||
## `sf project generate manifest` | ||
|
||
Create a project manifest that lists the metadata components you want to deploy or retrieve. | ||
|
||
``` | ||
USAGE | ||
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>] [-p <value>] [-n <value> | | ||
-t pre|post|destroy|package] [-c managed|unlocked --from-org <value>] [-d <value>] | ||
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>...] [-p <value>...] [-n | ||
<value> | -t pre|post|destroy|package] [-c managed|unlocked... --from-org <value>] [-d <value>] | ||
FLAGS | ||
-c, --include-packages=<option>... Package types (managed, unlocked) whose metadata is included in the manifest; by | ||
|
@@ -1339,7 +1340,7 @@ EXAMPLES | |
$ sf project generate manifest --from-org [email protected] --include-packages unlocked | ||
``` | ||
|
||
_See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/generate/manifest.ts)_ | ||
_See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/generate/manifest.ts)_ | ||
|
||
## `sf project list ignored` | ||
|
||
|
@@ -1381,7 +1382,7 @@ EXAMPLES | |
$ sf project list ignored --source-dir package.xml | ||
``` | ||
|
||
_See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/list/ignored.ts)_ | ||
_See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/list/ignored.ts)_ | ||
|
||
## `sf project reset tracking` | ||
|
||
|
@@ -1430,7 +1431,7 @@ EXAMPLES | |
$ sf project reset tracking --revision 30 | ||
``` | ||
|
||
_See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/reset/tracking.ts)_ | ||
_See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/reset/tracking.ts)_ | ||
|
||
## `sf project retrieve preview` | ||
|
||
|
@@ -1484,16 +1485,17 @@ FLAG DESCRIPTIONS | |
production orgs. | ||
``` | ||
|
||
_See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/retrieve/preview.ts)_ | ||
_See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/retrieve/preview.ts)_ | ||
|
||
## `sf project retrieve start` | ||
|
||
Retrieve metadata from an org to your local project. | ||
|
||
``` | ||
USAGE | ||
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value> | -d | ||
<value>] [-r <value> | -n <value> | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name <value> ] | ||
$ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value>... | -d | ||
<value>...] [-r <value> | -n <value>... | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name | ||
<value> ] | ||
FLAGS | ||
-a, --api-version=<value> Target API version for the retrieve. | ||
|
@@ -1642,6 +1644,6 @@ FLAG DESCRIPTIONS | |
If you specify this parameter, don’t specify --metadata or --source-dir. | ||
``` | ||
|
||
_See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.4/src/commands/project/retrieve/start.ts)_ | ||
_See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.9.0/src/commands/project/retrieve/start.ts)_ | ||
|
||
<!-- commandsstop --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters