Skip to content

Commit 6acf2dc

Browse files
committed
chore: update readme
1 parent c1be47f commit 6acf2dc

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,19 @@ $ sfdx plugins:install @salesforce/plugin-command-reference
1616
Ensure any plugins are installed that you with to generate documentation for.
1717

1818
```sh-session
19-
$ sfdx plugins:install salesforcedx
19+
$ sfdx plugins:install salesforcedx@latest-rc
2020
```
2121

22-
Now we can generate the documentation.
22+
Now we can generate the documentation for the `latest-rc` tag.
2323

2424
```sh-session
2525
$ sfdx commandreference --plugins salesforcedx
2626
```
2727

2828
**Note:** Warnings will occur for missing properties in plugins. Those have to be fixed in the plugin itself.
2929

30+
## Add to your Salesforce CLI Plugin
31+
3032
To add this to your plugin to catch warning at development time, add it as a dev plugin in the project.json.
3133

3234
```json
@@ -43,16 +45,36 @@ Then you can run this in your plugin's CI.
4345
./bin/run commandreference --plugins <name-of-your-plugin> --error-on-warnings
4446
```
4547

48+
## Local Development
49+
50+
If you need to make changes to this repository, the easiest thing to do is to link it to your Salesforce CLI. After you cloned this plugin, run the following from this plugin directory:
51+
52+
```sh-session
53+
sfdx plugins:link .
54+
```
55+
56+
Now, you can install any plugins you want and run the command reference generation on them.
57+
58+
```sh-session
59+
sfdx plugins:install salesforcedx
60+
sfdx plugins:install config
61+
sfdx plugins:install alias
62+
sfdx commandreference --plugins salesforcedx,alias,config
63+
```
64+
65+
## Commands
66+
4667
<!-- commands -->
47-
* [`sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-commandreferencegenerate--p-array--d-string---hidden---erroronwarnings---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
68+
69+
- [`sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-commandreferencegenerate--p-array--d-string---hidden---erroronwarnings---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
4870

4971
## `sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
5072

5173
generate the command reference guide located
5274

5375
```
5476
USAGE
55-
$ sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel
77+
$ sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel
5678
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
5779
5880
OPTIONS
@@ -75,4 +97,5 @@ OPTIONS
7597
```
7698

7799
_See code: [lib/commands/commandreference/generate.js](https://github.com/forcedotcom/plugin-command-reference/blob/v1.2.1/lib/commands/commandreference/generate.js)_
100+
78101
<!-- commandsstop -->

0 commit comments

Comments
 (0)