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.mdapi.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ To use Salesforce CLI to work with components that you retrieved via Metadata AP
8
8
9
9
To convert files from the source format back to the metadata format, run "sf project convert source".
10
10
11
-
To convert 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.
11
+
To convert 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 --source-dir.
12
12
13
13
# examples
14
14
@@ -42,7 +42,7 @@ Metadata component names to convert.
42
42
43
43
# flags.manifest.description
44
44
45
-
If you specify this parameter, don’t specify --metadata or --source-dir.
45
+
If you specify this flag, don’t specify --metadata or --source-dir.
46
46
47
47
# flags.metadata-dir.description
48
48
@@ -60,7 +60,7 @@ Expected a file but found a directory.
60
60
61
61
# InvalidFlagPath
62
62
63
-
The %s command parameter specifies an invalid path: %s
Copy file name to clipboardExpand all lines: messages/convert.source.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ To convert Metadata API–formatted files into the source format, run "<%= confi
10
10
11
11
To specify a package name that includes spaces, enclose the name in single quotes.
12
12
13
-
To convert multiple 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.
13
+
To convert multiple 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 --source-dir.
14
14
15
15
# examples
16
16
@@ -52,13 +52,13 @@ Metadata component names to convert.
52
52
53
53
# flags.manifest.description
54
54
55
-
If you specify this parameter, don’t specify --metadata or --source-dir.
55
+
If you specify this flag, don’t specify --metadata or --source-dir.
56
56
57
57
# flags.source-dir.description
58
58
59
59
The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).
60
60
61
-
If you specify this parameter, don’t specify --manifest or --metadata.
61
+
If you specify this flag, don’t specify --manifest or --metadata.
Copy file name to clipboardExpand all lines: messages/delete.source.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Use this command to delete components from orgs that don’t have source trackin
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
11
-
To delete 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.
11
+
To delete 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 --source-dir.
12
12
13
13
# examples
14
14
@@ -70,7 +70,7 @@ IMPORTANT: Where possible, we changed noninclusive terms to align with our compa
70
70
71
71
Validates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.
72
72
73
-
If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.
73
+
If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only flag to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.
74
74
75
75
If your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.
76
76
@@ -82,13 +82,13 @@ Note: A Metadata API deletion that includes Master-Detail relationships deletes
82
82
83
83
# flags.metadata.description
84
84
85
-
If you specify this parameter, don’t specify --source-dir.
85
+
If you specify this flag, don’t specify --source-dir.
86
86
87
87
# flags.source-dir.description
88
88
89
89
The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).
90
90
91
-
If you specify this parameter, don’t specify --metadata.
91
+
If you specify this flag, don’t specify --metadata.
Copy file name to clipboardExpand all lines: messages/delete.tracking.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ WARNING: This command deletes or overwrites all existing source tracking files.
8
8
9
9
Resets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.
10
10
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:
11
+
Use the --revision flag 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
13
<%= config.bin %> data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch
Copy file name to clipboardExpand all lines: messages/deploy.metadata.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Metadata components are deployed in source format by default. Deploy them in met
10
10
11
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
-
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.
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 --source-dir.
Copy file name to clipboardExpand all lines: messages/deploy.metadata.preview.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The command outputs a table that describes what will happen if you run the "<%=
10
10
11
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
-
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.
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 --source-dir.
Copy file name to clipboardExpand all lines: messages/deploy.metadata.validate.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ You must run this command from within a project.
10
10
11
11
This command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.
12
12
13
-
To validate 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.
13
+
To validate 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 --source-dir.
14
14
15
15
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. If you want to validate a deployment with tests on a sandbox, use "<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests" instead.
Copy file name to clipboardExpand all lines: messages/manifest.generate.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ Create a project manifest that lists the metadata components you want to deploy
4
4
5
5
# description
6
6
7
-
Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these parameters, not both.
7
+
Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these flags, not both.
8
8
9
-
Use --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are:
9
+
Use --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this flag, and their respective file names, are:
Copy file name to clipboardExpand all lines: messages/retrieve.start.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Metadata components are retrieved in source format by default. Retrieve them in
10
10
11
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
-
To retrieve multiple metadata components, either use multiple --metadata <name> flags or use 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.
13
+
To retrieve multiple metadata components, either use multiple --metadata <name> flags or use 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 --source-dir.
14
14
15
15
# examples
16
16
@@ -95,7 +95,7 @@ File path for the manifest (package.xml) that specifies the components to retrie
95
95
96
96
# flags.manifest.description
97
97
98
-
If you specify this parameter, don’t specify --metadata or --source-dir.
98
+
If you specify this flag, don’t specify --metadata or --source-dir.
0 commit comments