Skip to content

Commit

Permalink
chore(release): 3.0.74 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
svc-cli-bot committed Mar 31, 2024
1 parent 39e47a8 commit 8b3085a
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 4 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## [3.0.74](https://github.com/salesforcecli/plugin-command-reference/compare/3.0.73...3.0.74) (2024-03-31)

### Bug Fixes

- **deps:** bump @salesforce/kit from 3.0.15 to 3.1.0 ([5fae157](https://github.com/salesforcecli/plugin-command-reference/commit/5fae1575ef21802b776610ba593c93e57e41dd67))

## [3.0.73](https://github.com/salesforcecli/plugin-command-reference/compare/3.0.72...3.0.73) (2024-03-24)

### Bug Fixes
Expand Down
71 changes: 68 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,74 @@ Now diff the output. Changes should be intentional!

<!-- commands -->

# Command Topics
- [`sf commandreference generate`](#sf-commandreference-generate)
- [`sf jit install`](#sf-jit-install)

- [`sf commandreference`](docs/commandreference.md) - generate the Salesforce CLI command reference guide.
- [`sf jit`](docs/jit.md) - description for jit
## `sf commandreference generate`

generate the command reference guide located

```
USAGE
$ sf commandreference generate [--json] [-d <value>] [-p <value> | -a] [-s <value>] [--hidden] [--error-on-warnings] [-c
<value>]
FLAGS
-a, --all include all relevant plugins in the generation
-c, --config-path=<value> A path to the directory containing a plugin or cli
-d, --output-dir=<value> [default: ./tmp/root] output directory to put generated files
-p, --plugins=<value>... comma separated list of plugin names to be part of the generation. Defaults to the oclif
plugin in the current working directory
-s, --ditamap-suffix=<value> [default: unified] unique suffix to append to generated ditamap
--error-on-warnings fail the command if there are any warnings
--hidden show hidden commands
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
generate the command reference guide located
generate the command reference guide located
EXAMPLES
Generate the command reference guide
$ sf commandreference generate
Generate the command reference for a set of plugins
$ sf commandreference generate --plugins pluginA,pluginB
Generate the command reference for all plugins
$ sf commandreference generate --all --output-dir ./docs
Generate the command reference for all plugins in a directory
$ sf commandreference generate --all --config-path /path/to/plugin --output-dir ./docs
```

_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.74/src/commands/commandreference/generate.ts)_

## `sf jit install`

Install all JIT plugins.

```
USAGE
$ sf jit install [--json] [-d]
FLAGS
-d, --dry-run List the plugins that would be installed.
GLOBAL FLAGS
--json Format output as json.
EXAMPLES
$ sf jit install
```

_See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.74/src/commands/jit/install.ts)_

<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@salesforce/plugin-command-reference",
"description": "Generate the Salesforce CLI command reference guide",
"version": "3.0.73",
"version": "3.0.74",
"author": "Salesforce",
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
"dependencies": {
Expand Down

0 comments on commit 8b3085a

Please sign in to comment.