Skip to content

Commit

Permalink
fix: test 3
Browse files Browse the repository at this point in the history
  • Loading branch information
iowillhoit committed Sep 11, 2023
1 parent d3ed628 commit 03c3f2c
Showing 1 changed file with 88 additions and 21 deletions.
109 changes: 88 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-info.svg?label=@salesforce/plugin-info)](https://www.npmjs.com/package/@salesforce/plugin-info) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-info.svg)](https://npmjs.org/package/@salesforce/plugin-info) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-info/main/LICENSE.txt)

# Foo
# Foo 3

## Learn about the plugin-info

Expand Down Expand Up @@ -80,23 +80,33 @@ sfdx plugins

- [`sfdx doctor`](#sfdx-doctor)
- [`sfdx info:releasenotes:display`](#sfdx-inforeleasenotesdisplay)
- [`sfdx whatsnew`](#sfdx-whatsnew)

## `sfdx doctor`

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.
Gather CLI configuration data and run diagnostic tests to discover and report potential problems in your environment.

```
USAGE
$ sfdx doctor
$ sfdx doctor [--json] [-c <value>] [-p <value>] [-d <value>] [-i]
OPTIONS
-c, --command=command
-d, --output-dir=output-dir
-i, --create-issue
-p, --plugin=plugin
--json Format output as json.
FLAGS
-c, --command=<value> Command to run in debug mode; results are written to a log file.
-d, --output-dir=<value> Directory to save all created files rather than the current working directory.
-i, --create-issue Create a new issue on our GitHub repo and attach all diagnostic results.
-p, --plugin=<value> Specific plugin on which to run diagnostics.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
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.
Expand All @@ -105,37 +115,94 @@ DESCRIPTION
EXAMPLES
Run CLI doctor diagnostics:
sfdx doctor
$ sfdx doctor
Run CLI doctor diagnostics and the specified command, and write the debug output to a file:
sfdx doctor --command "force:org:list --all"
$ sfdx doctor --command "force:org:list --all"
Run CLI doctor diagnostics for a specific plugin:
sfdx doctor --plugin @salesforce/plugin-source
$ sfdx doctor --plugin @salesforce/plugin-source
```

_See code: [src/commands/doctor.ts](https://github.com/salesforcecli/plugin-info/blob/v2.3.2-t.0/src/commands/doctor.ts)_
_See code: [src/commands/doctor.ts](https://github.com/salesforcecli/plugin-info/blob/v2.6.42-dev.0/src/commands/doctor.ts)_

## `sfdx info:releasenotes:display`

Display Salesforce CLI release notes on the command line.

```
USAGE
$ sfdx info:releasenotes:display
$ sfdx info:releasenotes:display [--json] [-v <value>]
OPTIONS
-v, --version=version
--json Format output as json.
FLAGS
-v, --version=<value> CLI version or tag for which to display release notes.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Display Salesforce CLI release notes on the command line.
By default, this command displays release notes for the currently installed CLI version on your computer. Use the
--version flag to view release notes for a different release.
ALIASES
$ sfdx whatsnew
EXAMPLES
Display release notes for the currently installed CLI version:
sfdx info:releasenotes:display stable, stable-rc, latest, latest-rc, rc
$ sfdx info:releasenotes:display stable, stable-rc, latest, latest-rc, rc
Display release notes for CLI version 7.120.0:
sfdx info:releasenotes:display --version 7.120.0 stable, stable-rc, latest, latest-rc, rc
$ sfdx info:releasenotes:display --version 7.120.0 stable, stable-rc, latest, latest-rc, rc
Display release notes for the CLI version that corresponds to a tag (stable, stable-rc, latest, latest-rc, rc):
sfdx info:releasenotes:display --version latest
$ sfdx info:releasenotes:display --version latest
```

_See code: [src/commands/info/releasenotes/display.ts](https://github.com/salesforcecli/plugin-info/blob/v2.6.42-dev.0/src/commands/info/releasenotes/display.ts)_

## `sfdx whatsnew`

Display Salesforce CLI release notes on the command line.

```
USAGE
$ sfdx whatsnew [--json] [-v <value>]
FLAGS
-v, --version=<value> CLI version or tag for which to display release notes.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Display Salesforce CLI release notes on the command line.
By default, this command displays release notes for the currently installed CLI version on your computer. Use the
--version flag to view release notes for a different release.
ALIASES
$ sfdx whatsnew
_See code: [src/commands/info/releasenotes/display.ts](https://github.com/salesforcecli/plugin-info/blob/v2.3.2-t.0/src/commands/info/releasenotes/display.ts)_
EXAMPLES
Display release notes for the currently installed CLI version:
$ sfdx whatsnew stable, stable-rc, latest, latest-rc, rc
Display release notes for CLI version 7.120.0:
$ sfdx whatsnew --version 7.120.0 stable, stable-rc, latest, latest-rc, rc
Display release notes for the CLI version that corresponds to a tag (stable, stable-rc, latest, latest-rc, rc):
$ sfdx whatsnew --version latest
```

<!-- commandsstop -->

0 comments on commit 03c3f2c

Please sign in to comment.