@@ -16,17 +16,19 @@ $ sfdx plugins:install @salesforce/plugin-command-reference
16
16
Ensure any plugins are installed that you with to generate documentation for.
17
17
18
18
``` sh-session
19
- $ sfdx plugins:install salesforcedx
19
+ $ sfdx plugins:install salesforcedx@latest-rc
20
20
```
21
21
22
- Now we can generate the documentation.
22
+ Now we can generate the documentation for the ` latest-rc ` tag .
23
23
24
24
``` sh-session
25
25
$ sfdx commandreference --plugins salesforcedx
26
26
```
27
27
28
28
** Note:** Warnings will occur for missing properties in plugins. Those have to be fixed in the plugin itself.
29
29
30
+ ## Add to your Salesforce CLI Plugin
31
+
30
32
To add this to your plugin to catch warning at development time, add it as a dev plugin in the project.json.
31
33
32
34
``` json
@@ -43,16 +45,36 @@ Then you can run this in your plugin's CI.
43
45
./bin/run commandreference --plugins <name-of-your-plugin> --error-on-warnings
44
46
```
45
47
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
+
46
67
<!-- 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 )
48
70
49
71
## ` sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
50
72
51
73
generate the command reference guide located
52
74
53
75
```
54
76
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
56
78
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
57
79
58
80
OPTIONS
@@ -75,4 +97,5 @@ OPTIONS
75
97
```
76
98
77
99
_ See code: [ lib/commands/commandreference/generate.js] ( https://github.com/forcedotcom/plugin-command-reference/blob/v1.2.1/lib/commands/commandreference/generate.js ) _
100
+
78
101
<!-- commandsstop -->
0 commit comments