@salesforce/plugin-info 3.0.33 → 3.0.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -76,93 +76,9 @@ sfdx plugins
76
76
 
77
77
  <!-- commands -->
78
78
 
79
- - [`sf doctor`](#sf-doctor)
80
- - [`sf info releasenotes display`](#sf-info-releasenotes-display)
79
+ # Command Topics
81
80
 
82
- ## `sf doctor`
83
-
84
- Gather CLI configuration data and run diagnostic tests to discover and report potential problems in your environment.
85
-
86
- ```
87
- USAGE
88
- $ sf doctor [--json] [-c <value>] [-p <value>] [-d <value>] [-i]
89
-
90
- FLAGS
91
- -c, --command=<value> Command to run in debug mode; results are written to a log file.
92
- -d, --output-dir=<value> Directory to save all created files rather than the current working directory.
93
- -i, --create-issue Create a new issue on our GitHub repo and attach all diagnostic results.
94
- -p, --plugin=<value> Specific plugin on which to run diagnostics.
95
-
96
- GLOBAL FLAGS
97
- --json Format output as json.
98
-
99
- DESCRIPTION
100
- Gather CLI configuration data and run diagnostic tests to discover and report potential problems in your environment.
101
-
102
- When you run the doctor command without parameters, it first displays a diagnostic overview of your environment. It
103
- then writes a detailed diagnosis to a JSON file in the current directory. Use the --outputdir to specify a different
104
- directory. To run diagnostic tests on a specific plugin, use the --plugin parameter. If the plugin isn't listening to
105
- the doctor, then you get a warning.
106
-
107
- Use the --command parameter to run a specific command in debug mode; the doctor writes both stdout and stderr to
108
- \*.log files that you can provide to Salesforce Customer Support or attach to a GitHub issue.
109
-
110
- Plugin providers can also implement their own doctor diagnostic tests by listening to the "sf-doctor" event and
111
- running plugin specific tests that are then included in the doctor diagnostics log.
112
-
113
- EXAMPLES
114
- Run CLI doctor diagnostics:
115
-
116
- $ sf doctor
117
-
118
- Run CLI doctor diagnostics and the specified command, and write the debug output to a file:
119
-
120
- $ sf doctor --command "force:org:list --all"
121
-
122
- Run CLI doctor diagnostics for a specific plugin:
123
-
124
- $ sf doctor --plugin @salesforce/plugin-source
125
- ```
126
-
127
- _See code: [src/commands/doctor.ts](https://github.com/salesforcecli/plugin-info/blob/3.0.33/src/commands/doctor.ts)_
128
-
129
- ## `sf info releasenotes display`
130
-
131
- Display Salesforce CLI release notes on the command line.
132
-
133
- ```
134
- USAGE
135
- $ sf info releasenotes display [--json] [-v <value>]
136
-
137
- FLAGS
138
- -v, --version=<value> CLI version or tag for which to display release notes.
139
-
140
- GLOBAL FLAGS
141
- --json Format output as json.
142
-
143
- DESCRIPTION
144
- Display Salesforce CLI release notes on the command line.
145
-
146
- By default, this command displays release notes for the currently installed CLI version on your computer. Use the
147
- --version flag to view release notes for a different release.
148
-
149
- ALIASES
150
- $ sf whatsnew
151
-
152
- EXAMPLES
153
- Display release notes for the currently installed CLI version:
154
-
155
- $ sf info releasenotes display stable, stable-rc, latest, latest-rc, rc
156
-
157
- Display release notes for CLI version 7.120.0:
158
-
159
- $ sf info releasenotes display --version 7.120.0 stable, stable-rc, latest, latest-rc, rc
160
-
161
- Display release notes for the CLI version that corresponds to a tag (stable, stable-rc, latest, latest-rc, rc):
162
-
163
- $ sf info releasenotes display --version latest
164
- ```
165
-
166
- _See code: [src/commands/info/releasenotes/display.ts](https://github.com/salesforcecli/plugin-info/blob/3.0.33/src/commands/info/releasenotes/display.ts)_
81
+ - [`sf doctor`](docs/doctor.md) - Tools for diagnosing problems with Salesforce CLI.
82
+ - [`sf info`](docs/info.md) - Access Salesforce CLI information from the command line.
167
83
 
168
84
  <!-- commandsstop -->