Skip to content

Commit a572fbf

Browse files
committed
chore: update readme
1 parent 979babe commit a572fbf

3 files changed

Lines changed: 16 additions & 24 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@
66
/package-lock.json
77
/tmp
88
node_modules
9+
oclif.manifest.json

README.md

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Generate the [Salesforce CLI command reference guide](https://developer.salesfor
88
[![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-command-reference.svg)](https://npmjs.org/package/@salesforce/plugin-command-reference)
99
[![License](https://img.shields.io/npm/l/@salesforce/plugin-command-reference.svg)](https://github.com/salesforcecli/plugin-command-reference/blob/master/package.json)
1010

11-
<!-- install -->
12-
<!-- usage -->
1311
First install the plugin.
1412

1513
```sh-session
@@ -46,43 +44,36 @@ Then you can run this in your plugin's CI.
4644
./bin/run commandreference --plugins <name-of-your-plugin> --error-on-warnings
4745
```
4846

49-
<!-- usagestop -->
5047
<!-- commands -->
51-
* [`sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-helloorg--n-string--f--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
48+
* [`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)
5249

53-
## `sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
50+
## `sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
5451

55-
print a greeting and your org IDs
52+
generate the command reference guide located
5653

5754
```
5855
USAGE
59-
$ sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
56+
$ sfdx commandreference:generate -p <array> [-d <string>] [--hidden] [--erroronwarnings] [--json] [--loglevel
6057
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
6158
6259
OPTIONS
63-
-f, --force example boolean flag
64-
-n, --name=name name to print
60+
-d, --outputdir=outputdir [default: ./tmp/root] output
61+
directory to put generated files
6562
66-
-u, --targetusername=targetusername username or alias for the target
67-
org; overrides default target org
63+
-p, --plugins=plugins (required) comma separated list of
64+
plugin names to be part of the
65+
generation
6866
69-
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub
70-
org; overrides default dev hub org
67+
--erroronwarnings fail the command if there are any
68+
warnings
7169
72-
--apiversion=apiversion override the api version used for
73-
api requests made by this command
70+
--hidden show hidden commands
7471
7572
--json format output as json
7673
7774
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
7875
this command invocation
79-
80-
EXAMPLES
81-
$ sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
82-
Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
83-
My hub org id is: 00Dxx000000001234
84-
85-
$ sfdx hello:org --name myname --targetusername myOrg@example.com
86-
Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018!
8776
```
77+
78+
_See code: [lib/commands/commandreference/generate.js](https://github.com/salesforcecli/plugin-command-reference/blob/v0.0.0/lib/commands/commandreference/generate.js)_
8879
<!-- commandsstop -->

src/ditamap/command.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export class Command extends Ditamap {
6565
isBetaCommand: commandMeta.state === 'beta',
6666
trailblazerCommunityUrl,
6767
trailblazerCommunityName
68-
});
68+
}) as JsonMap;
6969

7070
// Override destination to include topic and subtopic
7171
if (subtopic) {

0 commit comments

Comments
 (0)