You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: messages/convert.source.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ Convert source-formatted files into metadata that you can deploy using Metadata
4
4
5
5
# description
6
6
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".
8
8
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".
10
10
11
11
To specify a package name that includes spaces, enclose the name in single quotes.
12
12
@@ -16,11 +16,11 @@ To convert multiple components, either set multiple --metadata <name> flags or a
16
16
17
17
- Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:
Copy file name to clipboardExpand all lines: messages/delete.source.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Delete source from your project and from a non-source-tracked org.
4
4
5
5
# description
6
6
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".
8
8
9
9
When you run this command, both the local source file and the metadata component in the org are deleted.
10
10
@@ -14,19 +14,19 @@ To delete multiple metadata components, either set multiple --metadata <name> fl
14
14
15
15
- Delete all local Apex source files and all Apex classes from the org with alias "my-scratch":
16
16
17
-
sf <%= command.id %> --metadata ApexClass --target-org my-scratch
- 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:
24
24
25
-
sf <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source
Copy file name to clipboardExpand all lines: messages/delete.tracking.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,23 +10,23 @@ Resets local and remote source tracking so that Salesforce CLI no longer registe
10
10
11
11
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:
12
12
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
14
14
15
15
# resetExample
16
16
17
17
- Reset source tracking for the org with alias "my-scratch":
@@ -26,10 +26,10 @@ Job ID of the deploy operation you want to cancel.
26
26
27
27
These commands return a job ID if they time out or you specified the --async flag:
28
28
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
33
33
34
34
The job ID is valid for 10 days from when you started the deploy operation.
35
35
@@ -47,15 +47,15 @@ Number of minutes to wait for the command to complete and display results.
47
47
48
48
# flags.wait.description
49
49
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".
51
51
52
52
# flags.async.summary
53
53
54
54
Run the command asynchronously.
55
55
56
56
# flags.async.description
57
57
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".
Copy file name to clipboardExpand all lines: messages/deploy.metadata.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,36 +8,36 @@ You must run this command from within a project.
8
8
9
9
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.
10
10
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.
12
12
13
13
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.
14
14
15
15
# examples
16
16
17
17
- Deploy local changes not in the org; uses your default org:
18
18
19
-
sf <%= command.id %>
19
+
<%= config.bin %> <%= command.id %>
20
20
21
21
- 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:
22
22
23
-
sf <%= command.id %> --source-dir force-app --target-org my-scratch --concise
- 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:
26
26
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
- 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!):
35
35
36
-
sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
- 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):
39
39
40
-
sf <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings
@@ -114,7 +114,7 @@ Number of minutes to wait for command to complete and display results.
114
114
115
115
# flags.wait.description
116
116
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".
118
118
119
119
# flags.manifest.summary
120
120
@@ -176,7 +176,7 @@ Run the command asynchronously.
176
176
177
177
# flags.async.description
178
178
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".
Copy file name to clipboardExpand all lines: messages/deploy.metadata.preview.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,31 +6,31 @@ Preview a deployment to see what will deploy to the org, the potential conflicts
6
6
7
7
You must run this command from within a project.
8
8
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.
10
10
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.
12
12
13
13
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.
14
14
15
15
# examples
16
16
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.
18
18
19
19
- Preview the deployment of source files in a directory, such as force-app, to your default org:
0 commit comments