generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
14 changed files
with
299 additions
and
188 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# commandDescription | ||
|
||
Display Salesforce CLI release notes on the command line. | ||
|
||
# flags.version.summary | ||
|
||
CLI version or tag for which to display release notes. | ||
|
||
# flags.version.description | ||
|
||
CLI version or tag for which to display release notes. | ||
|
||
# flags.hook.summary | ||
|
||
This hidden parameter is used in post install or update hooks. | ||
|
||
# flags.hook.description | ||
|
||
This hidden parameter is used in post install or update hooks. | ||
|
||
# examples | ||
|
||
- Display release notes for the currently installed CLI version: | ||
$ <%= config.bin %> <%= command.id %> | ||
Display release notes for CLI version 7.120.0: | ||
$ <%= config.bin %> <%= command.id %> --version 7.120.0 | ||
Display release notes for the CLI version that corresponds to a tag (%s): | ||
$ <%= config.bin %> <%= command.id %> --version latest | ||
|
||
# footer | ||
|
||
--- | ||
|
||
- Run `%s whatsnew` to manually view the current release notes. | ||
- You can also view them on GitHub by visiting the [forcedotcom/cli](%s) repo. | ||
- Silence notes by setting the `%s` env var to `true`. | ||
- Hide this footer by setting the `%s` env var to `true`. | ||
|
||
--- |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# commandDescription | ||
|
||
Gather CLI configuration data and run diagnostic tests to discover and report potential problems in your environment. | ||
|
||
When you run the doctor command without parameters, it first displays a diagnostic overview of your environment. It then writes a detailed diagnosis to a JSON file in the current directory. Use the --outputdir to specify a different directory. To run diagnostic tests on a specific plugin, use the --plugin parameter. If the plugin isn't listening to the doctor, then you get a warning. | ||
|
||
Use the --command parameter to run a specific command in debug mode; the doctor writes both stdout and stderr to \*.log files that you can provide to Salesforce Customer Support or attach to a GitHub issue. | ||
|
||
Plugin providers can also implement their own doctor diagnostic tests by listening to the "sf-doctor" event and running plugin specific tests that are then included in the doctor diagnostics log. | ||
|
||
# flags.command | ||
|
||
command to run in debug mode ; results are written to a log file | ||
|
||
# flags.plugin | ||
|
||
specific plugin on which to run diagnostics | ||
|
||
# flags.output-dir.summary | ||
|
||
directory to save all created files rather than the current working directory | ||
|
||
# flags.create-issue.summary | ||
|
||
create a new issue on our GitHub repo and attach all diagnostic results | ||
|
||
# examples | ||
|
||
- Run CLI doctor diagnostics: | ||
$ <%= config.bin %> doctor | ||
Run CLI doctor diagnostics and the specified command, and write the debug output to a file: | ||
$ <%= config.bin %> doctor --command "force:org:list --all" | ||
Run CLI doctor diagnostics for a specific plugin: | ||
$ <%= config.bin %> doctor --plugin @salesforce/plugin-source | ||
|
||
# pinnedSuggestions.checkGitHubIssues | ||
|
||
Check https://github.com/forcedotcom/cli/issues for CLI issues posted by the community. | ||
|
||
# pinnedSuggestions.checkSfdcStatus | ||
|
||
Check http://status.salesforce.com for general Salesforce availability and performance. | ||
|
||
# doctorNotInitializedError | ||
|
||
Must first initialize a new SfDoctor. | ||
|
||
# doctorAlreadyInitializedError | ||
|
||
SfDoctor has already been initialized. | ||
|
||
# pluginNotInstalledError | ||
|
||
Specified plugin [%s] isn't installed. Install it, correct the name, or choose another plugin. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.