Skip to content

Commit 816d9d9

Browse files
authored
docs: restore some config.bin for --help stuff (#1029)
* docs: restore some config.bin for --help stuff * fix: the one I missed
1 parent 42f1265 commit 816d9d9

15 files changed

+101
-101
lines changed

messages/convert.mdapi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ To convert multiple metadata components, either set multiple --metadata <name> f
1414

1515
- Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:
1616

17-
$ sf <%= command.id %> --root-dir path/to/metadata
17+
$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata
1818

1919
- Similar to previous example, but writes converted files to the specified output directory:
2020

21-
$ sf <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir
21+
$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir
2222

2323
# flags.root-dir.summary
2424

messages/convert.source.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Convert source-formatted files into metadata that you can deploy using Metadata
44

55
# description
66

7-
To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using "sf project deploy".
7+
To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using "<%= config.bin %> project deploy".
88

9-
To convert Metadata API–formatted files into the source format, run "sf project convert mdapi".
9+
To convert Metadata API–formatted files into the source format, run "<%= config.bin %> project convert mdapi".
1010

1111
To specify a package name that includes spaces, enclose the name in single quotes.
1212

@@ -16,11 +16,11 @@ To convert multiple components, either set multiple --metadata <name> flags or a
1616

1717
- Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:
1818

19-
$ sf <%= command.id %> --root-dir path/to/source
19+
$ <%= config.bin %> <%= command.id %> --root-dir path/to/source
2020

2121
- Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:
2222

23-
$ sf <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'
23+
$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'
2424

2525
# flags.api-version.summary
2626

messages/delete.source.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Delete source from your project and from a non-source-tracked org.
44

55
# description
66

7-
Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, "sf project deploy start".
7+
Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, "<%= config.bin %> project deploy start".
88

99
When you run this command, both the local source file and the metadata component in the org are deleted.
1010

@@ -14,19 +14,19 @@ To delete multiple metadata components, either set multiple --metadata <name> fl
1414

1515
- Delete all local Apex source files and all Apex classes from the org with alias "my-scratch":
1616

17-
sf <%= command.id %> --metadata ApexClass --target-org my-scratch
17+
<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch
1818

1919
- Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:
2020

21-
sf <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt
21+
<%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata "Profile: My Profile" --no-prompt
2222

2323
- Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:
2424

25-
sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source
25+
<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source
2626

2727
- Delete the Apex source files in a directory and the corresponding components from your default org:
2828

29-
sf <%= command.id %> --source-dir force-app/main/default/classes
29+
<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes
3030

3131
# flags.source-dir.summary
3232

messages/delete.tracking.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ Resets local and remote source tracking so that Salesforce CLI no longer registe
1010

1111
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 'data soql' command. For example:
1212

13-
sf data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch
13+
<%= config.bin %> data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch
1414

1515
# resetExample
1616

1717
- Reset source tracking for the org with alias "my-scratch":
1818

19-
$ sf <%= command.id %> --target-org my-scratch
19+
$ <%= config.bin %> <%= command.id %> --target-org my-scratch
2020

2121
- Reset source tracking to revision number 30 for your default org:
2222

23-
$ sf <%= command.id %> --revision 30
23+
$ <%= config.bin %> <%= command.id %> --revision 30
2424

2525
# deleteExample
2626

2727
- Delete local source tracking for the org with alias "my-scratch":
2828

29-
$ sf <%= command.id %> --target-org my-scratch
29+
$ <%= config.bin %> <%= command.id %> --target-org my-scratch
3030

3131
# deleteSummary
3232

messages/deploy.metadata.cancel.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ Run this command by either passing it a job ID or specifying the --use-most-rece
1212

1313
- Cancel a deploy operation using a job ID:
1414

15-
sf <%= command.id %> --job-id 0Af0x000017yLUFCA2
15+
<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2
1616

1717
- Cancel the most recent deploy operation:
1818

19-
sf <%= command.id %> --use-most-recent
19+
<%= config.bin %> <%= command.id %> --use-most-recent
2020

2121
# flags.job-id.summary
2222

@@ -26,10 +26,10 @@ Job ID of the deploy operation you want to cancel.
2626

2727
These commands return a job ID if they time out or you specified the --async flag:
2828

29-
- sf project deploy start
30-
- sf project deploy validate
31-
- sf project deploy quick
32-
- sf project deploy cancel
29+
- <%= config.bin %> project deploy start
30+
- <%= config.bin %> project deploy validate
31+
- <%= config.bin %> project deploy quick
32+
- <%= config.bin %> project deploy cancel
3333

3434
The job ID is valid for 10 days from when you started the deploy operation.
3535

@@ -47,15 +47,15 @@ Number of minutes to wait for the command to complete and display results.
4747

4848
# flags.wait.description
4949

50-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "sf project deploy report".
50+
If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run "<%= config.bin %> project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report".
5151

5252
# flags.async.summary
5353

5454
Run the command asynchronously.
5555

5656
# flags.async.description
5757

58-
The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "sf project deploy report".
58+
The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run "<%= config.bin %> project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report".
5959

6060
# error.CannotCancelDeploy
6161

messages/deploy.metadata.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,36 @@ You must run this command from within a project.
88

99
Metadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.
1010

11-
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create scratch|sandbox" commands.
11+
If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
1212

1313
To deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
1414

1515
# examples
1616

1717
- Deploy local changes not in the org; uses your default org:
1818

19-
sf <%= command.id %>
19+
<%= config.bin %> <%= command.id %>
2020

2121
- Deploy all source files in the "force-app" directory to an org with alias "my-scratch"; show only concise output, in other words don't print a list of all the source that was deployed:
2222

23-
sf <%= command.id %> --source-dir force-app --target-org my-scratch --concise
23+
<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise
2424

2525
- Deploy all the Apex classes and custom objects that are in the "force-app" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:
2626

27-
sf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28-
sf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
27+
<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28+
<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
2929

3030
- Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
3131

32-
sf <%= command.id %> --metadata ApexClass
32+
<%= config.bin %> <%= command.id %> --metadata ApexClass
3333

3434
- Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):
3535

36-
sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
36+
<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
3737

3838
- Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string "MyApex". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):
3939

40-
sf <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings
40+
<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings
4141

4242
- Deploy a custom object called ExcitingObject that's in the SBQQ namespace:
4343

@@ -49,20 +49,20 @@ To deploy multiple metadata components, either set multiple --metadata <name> fl
4949

5050
- Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
5151

52-
sf <%= command.id %> --metadata CustomObject ApexClass
53-
sf <%= command.id %> --metadata CustomObject --metadata ApexClass
52+
<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass
53+
<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass
5454

5555
- Deploy all Apex classes and a profile that has a space in its name:
5656

57-
sf <%= command.id %> --metadata ApexClass --metadata "Profile:My Profile"
57+
<%= config.bin %> <%= command.id %> --metadata ApexClass --metadata "Profile:My Profile"
5858

5959
- Deploy all components listed in a manifest:
6060

61-
sf <%= command.id %> --manifest path/to/package.xml
61+
<%= config.bin %> <%= command.id %> --manifest path/to/package.xml
6262

6363
- Run the tests that aren’t in any managed packages as part of a deployment:
6464

65-
sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests
65+
<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests
6666

6767
# flags.pre-destructive-changes.summary
6868

@@ -114,7 +114,7 @@ Number of minutes to wait for command to complete and display results.
114114

115115
# flags.wait.description
116116

117-
If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run "sf project deploy resume". To check the status of the deployment, run "sf project deploy report".
117+
If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run "<%= config.bin %> project deploy resume". To check the status of the deployment, run "<%= config.bin %> project deploy report".
118118

119119
# flags.manifest.summary
120120

@@ -176,7 +176,7 @@ Run the command asynchronously.
176176

177177
# flags.async.description
178178

179-
The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run "sf project deploy resume". To check the status of the deployment, run "sf project deploy report".
179+
The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run "<%= config.bin %> project deploy resume". To check the status of the deployment, run "<%= config.bin %> project deploy report".
180180

181181
# flags.metadata-dir.summary
182182

messages/deploy.metadata.preview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,31 @@ Preview a deployment to see what will deploy to the org, the potential conflicts
66

77
You must run this command from within a project.
88

9-
The command outputs a table that describes what will happen if you run the "sf project deploy start" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.
9+
The command outputs a table that describes what will happen if you run the "<%= config.bin %> project deploy start" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.
1010

11-
If your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create scratch|sandbox" commands.
11+
If your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
1212

1313
To preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
1414

1515
# examples
1616

17-
- NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for "sf project deploy start" for more examples that you can adapt for previewing.
17+
- NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for "<%= config.bin %> project deploy start" for more examples that you can adapt for previewing.
1818

1919
- Preview the deployment of source files in a directory, such as force-app, to your default org:
2020

21-
sf <%= command.id %> --source-dir force-app
21+
<%= config.bin %> <%= command.id %> --source-dir force-app
2222

2323
- Preview the deployment of all Apex classes to an org with alias "my-scratch":
2424

25-
sf <%= command.id %> --metadata ApexClass --target-org my-scratch
25+
<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch
2626

2727
- Preview deployment of a specific Apex class:
2828

29-
sf <%= command.id %> --metadata ApexClass:MyApexClass
29+
<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass
3030

3131
- Preview deployment of all components listed in a manifest:
3232

33-
sf <%= command.id %> --manifest path/to/package.xml
33+
<%= config.bin %> <%= command.id %> --manifest path/to/package.xml
3434

3535
# flags.only-ignored.summary
3636

0 commit comments

Comments
 (0)