Skip to content

Commit ac76b57

Browse files
jshackell-sfdcjshackell-sfdc
authored
update help file for "sf"
1 parent 2a0ca0a commit ac76b57

1 file changed

Lines changed: 38 additions & 51 deletions

File tree

‎templates/cli_reference_help.hbs‎

Lines changed: 38 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ THIS FILE IS AUTOGENERATED. DON’T MAKE CHANGES TO THIS FILE IN PERFORCE! YOUR
99
IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR DETAILS.
1010
1111
-->
12-
<title>Help for Salesforce CLI Commands</title>
13-
<shortdesc>The <codeph otherprops="nolang">-h</codeph> | <codeph otherprops="nolang"
14-
>--help</codeph> parameter shows details about Salesforce CLI topics and their
15-
commands.</shortdesc>
12+
<title>Help for <codeph otherprops="nolang">sf</codeph> Commands</title>
13+
<shortdesc>The <codeph otherprops="nolang">-h</codeph> and <codeph otherprops="nolang"
14+
>--help</codeph> flags show details about <codeph otherprops="nolang">sf</codeph> topics and
15+
their commands.</shortdesc>
1616
<prolog>
1717
<metadata>
1818
<othermeta content="concept" name="topic_type"/>
@@ -23,56 +23,43 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
2323
</metadata>
2424
</prolog>
2525
<conbody>
26-
<p>For namespaces, the <codeph otherprops="nolang">-h</codeph> | <codeph otherprops="nolang"
27-
>--help</codeph> parameter lists all topics in the namespace. For example, to see names and
28-
descriptions of all topics in the <codeph otherprops="nolang">force</codeph> namespace, run
29-
<codeph otherprops="nolang">sfdx force -h</codeph>.</p>
30-
<p>For topics, the <codeph otherprops="nolang">-h</codeph> | <codeph otherprops="nolang"
31-
>--help</codeph> parameter lists the commands and their descriptions. For example, to see
32-
all commands in the <codeph otherprops="nolang">org</codeph> topic, run <codeph
33-
otherprops="nolang">sfdx force:org -h</codeph>.</p>
34-
<p>For commands, adding the <codeph otherprops="nolang">-h</codeph> | <codeph otherprops="nolang"
35-
>--help</codeph> parameter shows parameters and usage information. For example, to see help for
36-
the <codeph otherprops="nolang">org:create</codeph> command, run <codeph otherprops="nolang">sfdx
37-
force:org:create -h</codeph>.</p>
38-
<p>Help for commands has four parts.<ol>
26+
<p>The short <codeph otherprops="nolang">-h</codeph> flag shows a subset of the command-line
27+
help and is meant for quick reference. The long <codeph otherprops="nolang">--help</codeph>
28+
flag shows the complete command-line help. </p>
29+
<p>The short help (<codeph otherprops="nolang">-h</codeph>) for commands has these parts.<ol>
3930
<li><b>Short Description of Command</b><p>At the top of the <codeph otherprops="nolang"
40-
>--help</codeph> output (with no heading), a short description of the command is
41-
shown. For longer descriptions, see the <cite>Salesforce CLI Command
42-
Reference</cite>.</p></li>
31+
>-h</codeph> output (with no heading), a short description of the command is shown.
32+
</p></li>
4333
<li><b>Usage</b><p>The command signature on the Usage line uses the docopt format.<ul>
44-
<li>All available parameters are listed. Parameters that have short names are listed
45-
using their short names.</li>
46-
<li>Parameters that take a value show the value’s type (for example, <codeph
47-
otherprops="nolang">&lt;string></codeph>) in angle brackets immediately after the
48-
parameter’s name.</li>
49-
<li>Optional parameters are in square brackets (<codeph otherprops="nolang">[ …
50-
]</codeph>).</li>
51-
<li>Required parameters have no annotation.</li>
52-
<li>For parameters that accept a limited set of values, the values are shown after the
53-
parameter name, separated by pipes (<codeph otherprops="nolang">--parametername
34+
<li>All available flags are listed. Flags that have short names are listed using their
35+
short names.</li>
36+
<li>Flags that take a value show <codeph otherprops="nolang">&lt;value></codeph>
37+
immediately after the flag’s name.</li>
38+
<li>Optional flags are in square brackets (<codeph otherprops="nolang">[ …
39+
]</codeph>).</li>
40+
<li>Required flags have no annotation.</li>
41+
<li>For flags that accept a limited set of values, the values are shown after the flag
42+
name, separated by pipes (<codeph otherprops="nolang">--flagname
5443
value1|value2|value3</codeph>).</li>
55-
<li>Mutually exclusive options are shown in parentheses, separated by a pipe (<codeph
56-
otherprops="nolang">( … | … )</codeph>).</li>
57-
</ul></p><p>If the command takes varargs (name-value pairs that aren’t parameters), the
58-
usage signature includes <codeph otherprops="nolang">name=value...</codeph>.</p><note
59-
type="tip">To see all Salesforce CLI commands, run <codeph otherprops="nolang">sfdx
60-
commands</codeph>.</note></li>
61-
<li><b>Options</b><p>The Options section lists all the command’s parameters, including their
62-
short name, long name, and purpose. For parameters that accept a value, the value name
63-
is written after an equals sign (<codeph otherprops="nolang">=</codeph>). The equals
64-
sign is optional when you run the command—for example, you could run <codeph
65-
otherprops="nolang">sfdx force:org:create
66-
<varname>-f=config/enterprise-scratch-def.json</varname> -a TestOrg1</codeph> or
67-
<codeph otherprops="nolang">sfdx force:org:create <varname>-f
68-
config/enterprise-scratch-def.json</varname> -a TestOrg1</codeph> with the same
69-
results.</p><p>Parameters that accept a limited list of values include the values in
70-
parentheses, with the default value indicated by an asterisk (<codeph
71-
otherprops="nolang">*</codeph>).</p><p>For more information about the parameters, see
72-
the <cite>Salesforce CLI Command Reference</cite>.</p></li>
73-
<li><b>Description</b><p>Usage notes and examples are below the list of parameters, in the
74-
Description section. This information is also available in the <cite>Salesforce CLI
75-
Command Reference</cite>.</p></li>
44+
</ul></p></li>
45+
<li><b>Flags</b><p>The Flags section lists all the command’s flags, including their short
46+
name, long name, and purpose. Flags are grouped for easier reading, such as global flags
47+
and other groups relevant to a specific command. </p><p>For flags that take multiple
48+
values, you have two ways to specify the values:<ul>
49+
<li>Specify the flag multiple times, where each flag takes a different single
50+
value.</li>
51+
<li>Specify the flag one time, but separate all the values with a space.</li>
52+
</ul></p><p>For example, the following commands are
53+
equivalent:<codeblock otherprops="nolang">sf deploy metadata --metadata ApexClass --metadata CustomObject --metadata AnotherCustomObject
54+
sf deploy metadata --metadata ApexClass CustomObject AnotherCustomObject</codeblock></p><p>Flags
55+
that accept a limited list of values include the values in parentheses, with the default
56+
value specified with the <codeph otherprops="nolang">default</codeph> keyword. </p></li>
57+
</ol></p>
58+
<p>The long help (<codeph otherprops="nolang">--help</codeph>) for commands has the same parts
59+
as the preceding short help <codeph otherprops="nolang">-h</codeph>) and these additional parts.<ol>
60+
<li><b>Description</b><p>Usage notes. </p></li>
61+
<li><b>Examples</b><p>All examples include a brief description.</p></li>
62+
<li><b>Flag Descriptions</b><p>Some flags have optional additional usage notes.</p></li>
7663
</ol></p>
7764
</conbody>
7865
</concept>

0 commit comments

Comments
 (0)