Skip to content

Commit 8b3085a

Browse files
committed
chore(release): 3.0.74 [skip ci]
1 parent 39e47a8 commit 8b3085a

File tree

3 files changed

+75
-4
lines changed

3 files changed

+75
-4
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## [3.0.74](https://github.com/salesforcecli/plugin-command-reference/compare/3.0.73...3.0.74) (2024-03-31)
2+
3+
### Bug Fixes
4+
5+
- **deps:** bump @salesforce/kit from 3.0.15 to 3.1.0 ([5fae157](https://github.com/salesforcecli/plugin-command-reference/commit/5fae1575ef21802b776610ba593c93e57e41dd67))
6+
17
## [3.0.73](https://github.com/salesforcecli/plugin-command-reference/compare/3.0.72...3.0.73) (2024-03-24)
28

39
### Bug Fixes

README.md

Lines changed: 68 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,74 @@ Now diff the output. Changes should be intentional!
8181

8282
<!-- commands -->
8383

84-
# Command Topics
84+
- [`sf commandreference generate`](#sf-commandreference-generate)
85+
- [`sf jit install`](#sf-jit-install)
8586

86-
- [`sf commandreference`](docs/commandreference.md) - generate the Salesforce CLI command reference guide.
87-
- [`sf jit`](docs/jit.md) - description for jit
87+
## `sf commandreference generate`
88+
89+
generate the command reference guide located
90+
91+
```
92+
USAGE
93+
$ sf commandreference generate [--json] [-d <value>] [-p <value> | -a] [-s <value>] [--hidden] [--error-on-warnings] [-c
94+
<value>]
95+
96+
FLAGS
97+
-a, --all include all relevant plugins in the generation
98+
-c, --config-path=<value> A path to the directory containing a plugin or cli
99+
-d, --output-dir=<value> [default: ./tmp/root] output directory to put generated files
100+
-p, --plugins=<value>... comma separated list of plugin names to be part of the generation. Defaults to the oclif
101+
plugin in the current working directory
102+
-s, --ditamap-suffix=<value> [default: unified] unique suffix to append to generated ditamap
103+
--error-on-warnings fail the command if there are any warnings
104+
--hidden show hidden commands
105+
106+
GLOBAL FLAGS
107+
--json Format output as json.
108+
109+
DESCRIPTION
110+
generate the command reference guide located
111+
112+
generate the command reference guide located
113+
114+
EXAMPLES
115+
Generate the command reference guide
116+
117+
$ sf commandreference generate
118+
119+
Generate the command reference for a set of plugins
120+
121+
$ sf commandreference generate --plugins pluginA,pluginB
122+
123+
Generate the command reference for all plugins
124+
125+
$ sf commandreference generate --all --output-dir ./docs
126+
127+
Generate the command reference for all plugins in a directory
128+
129+
$ sf commandreference generate --all --config-path /path/to/plugin --output-dir ./docs
130+
```
131+
132+
_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.74/src/commands/commandreference/generate.ts)_
133+
134+
## `sf jit install`
135+
136+
Install all JIT plugins.
137+
138+
```
139+
USAGE
140+
$ sf jit install [--json] [-d]
141+
142+
FLAGS
143+
-d, --dry-run List the plugins that would be installed.
144+
145+
GLOBAL FLAGS
146+
--json Format output as json.
147+
148+
EXAMPLES
149+
$ sf jit install
150+
```
151+
152+
_See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.74/src/commands/jit/install.ts)_
88153

89154
<!-- commandsstop -->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-command-reference",
33
"description": "Generate the Salesforce CLI command reference guide",
4-
"version": "3.0.73",
4+
"version": "3.0.74",
55
"author": "Salesforce",
66
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)