Skip to content

Commit b1a00b8

Browse files
Update generated readme
1 parent 122d685 commit b1a00b8

File tree

2 files changed

+45
-77
lines changed

2 files changed

+45
-77
lines changed

packages/cli/README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -771,33 +771,29 @@ DESCRIPTION
771771

772772
## `shopify commands`
773773

774-
list all the commands
774+
List all shopify commands.
775775

776776
```
777777
USAGE
778-
$ shopify commands [--columns <value> | -x] [--deprecated] [--filter <value>] [-h] [--hidden] [--json]
779-
[--no-header | [--csv | --no-truncate]] [--output csv|json|yaml | | ] [--sort <value>] [--tree]
778+
$ shopify commands [-c id|plugin|summary|type | --tree] [--deprecated] [-x | ] [--hidden] [--json]
779+
[--no-truncate | ] [--sort id|plugin|summary|type | ]
780780
781781
FLAGS
782-
-h, --help Show CLI help.
783-
-x, --extended show extra columns
784-
--columns=<value> only show provided columns (comma-separated)
785-
--csv output is csv format [alias: --output=csv]
786-
--deprecated show deprecated commands
787-
--filter=<value> filter property by partial string matching, ex: name=foo
788-
--hidden show hidden commands
789-
--no-header hide table header from output
790-
--no-truncate do not truncate output to fit screen
791-
--output=<option> output in a more machine friendly format
792-
<options: csv|json|yaml>
793-
--sort=<value> property to sort by (prepend '-' for descending)
794-
--tree show tree of commands
782+
-c, --columns=<option>... Only show provided columns (comma-separated).
783+
<options: id|plugin|summary|type>
784+
-x, --extended Show extra columns.
785+
--deprecated Show deprecated commands.
786+
--hidden Show hidden commands.
787+
--no-truncate Do not truncate output.
788+
--sort=<option> [default: id] Property to sort by.
789+
<options: id|plugin|summary|type>
790+
--tree Show tree of commands.
795791
796792
GLOBAL FLAGS
797793
--json Format output as json.
798794
799795
DESCRIPTION
800-
list all the commands
796+
List all shopify commands.
801797
```
802798

803799
## `shopify config autocorrect off`
@@ -1559,6 +1555,7 @@ FLAGS
15591555
15601556
DESCRIPTION
15611557
Links a plugin into the CLI for development.
1558+
15621559
Installation of a linked plugin will override a user-installed or core plugin.
15631560
15641561
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'

packages/cli/oclif.manifest.json

Lines changed: 31 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -2360,61 +2360,46 @@
23602360
"args": {
23612361
},
23622362
"customPluginName": "@oclif/plugin-commands",
2363-
"description": "list all the commands",
2363+
"description": "List all <%= config.bin %> commands.",
23642364
"enableJsonFlag": true,
23652365
"flags": {
23662366
"columns": {
2367-
"description": "only show provided columns (comma-separated)",
2367+
"char": "c",
2368+
"delimiter": ",",
2369+
"description": "Only show provided columns (comma-separated).",
23682370
"exclusive": [
2369-
"extended"
2371+
"tree"
23702372
],
23712373
"hasDynamicHelp": false,
2372-
"multiple": false,
2374+
"multiple": true,
23732375
"name": "columns",
2374-
"type": "option"
2375-
},
2376-
"csv": {
2377-
"allowNo": false,
2378-
"description": "output is csv format [alias: --output=csv]",
2379-
"exclusive": [
2380-
"no-truncate"
2376+
"options": [
2377+
"id",
2378+
"plugin",
2379+
"summary",
2380+
"type"
23812381
],
2382-
"name": "csv",
2383-
"type": "boolean"
2382+
"type": "option"
23842383
},
23852384
"deprecated": {
23862385
"allowNo": false,
2387-
"description": "show deprecated commands",
2386+
"description": "Show deprecated commands.",
23882387
"name": "deprecated",
23892388
"type": "boolean"
23902389
},
23912390
"extended": {
23922391
"allowNo": false,
23932392
"char": "x",
2394-
"description": "show extra columns",
2393+
"description": "Show extra columns.",
23952394
"exclusive": [
2396-
"columns"
2395+
"tree"
23972396
],
23982397
"name": "extended",
23992398
"type": "boolean"
24002399
},
2401-
"filter": {
2402-
"description": "filter property by partial string matching, ex: name=foo",
2403-
"hasDynamicHelp": false,
2404-
"multiple": false,
2405-
"name": "filter",
2406-
"type": "option"
2407-
},
2408-
"help": {
2409-
"allowNo": false,
2410-
"char": "h",
2411-
"description": "Show CLI help.",
2412-
"name": "help",
2413-
"type": "boolean"
2414-
},
24152400
"hidden": {
24162401
"allowNo": false,
2417-
"description": "show hidden commands",
2402+
"description": "Show hidden commands.",
24182403
"name": "hidden",
24192404
"type": "boolean"
24202405
},
@@ -2425,50 +2410,35 @@
24252410
"name": "json",
24262411
"type": "boolean"
24272412
},
2428-
"no-header": {
2429-
"allowNo": false,
2430-
"description": "hide table header from output",
2431-
"exclusive": [
2432-
"csv"
2433-
],
2434-
"name": "no-header",
2435-
"type": "boolean"
2436-
},
24372413
"no-truncate": {
24382414
"allowNo": false,
2439-
"description": "do not truncate output to fit screen",
2415+
"description": "Do not truncate output.",
24402416
"exclusive": [
2441-
"csv"
2417+
"tree"
24422418
],
24432419
"name": "no-truncate",
24442420
"type": "boolean"
24452421
},
2446-
"output": {
2447-
"description": "output in a more machine friendly format",
2422+
"sort": {
2423+
"default": "id",
2424+
"description": "Property to sort by.",
24482425
"exclusive": [
2449-
"no-truncate",
2450-
"csv"
2426+
"tree"
24512427
],
24522428
"hasDynamicHelp": false,
24532429
"multiple": false,
2454-
"name": "output",
2430+
"name": "sort",
24552431
"options": [
2456-
"csv",
2457-
"json",
2458-
"yaml"
2432+
"id",
2433+
"plugin",
2434+
"summary",
2435+
"type"
24592436
],
24602437
"type": "option"
24612438
},
2462-
"sort": {
2463-
"description": "property to sort by (prepend '-' for descending)",
2464-
"hasDynamicHelp": false,
2465-
"multiple": false,
2466-
"name": "sort",
2467-
"type": "option"
2468-
},
24692439
"tree": {
24702440
"allowNo": false,
2471-
"description": "show tree of commands",
2441+
"description": "Show tree of commands.",
24722442
"name": "tree",
24732443
"type": "boolean"
24742444
}
@@ -4654,7 +4624,7 @@
46544624
}
46554625
},
46564626
"customPluginName": "@oclif/plugin-plugins",
4657-
"description": "Links a plugin into the CLI for development.\nInstallation of a linked plugin will override a user-installed or core plugin.\n\ne.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.\n",
4627+
"description": "Installation of a linked plugin will override a user-installed or core plugin.\n\ne.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.\n",
46584628
"enableJsonFlag": false,
46594629
"examples": [
46604630
"<%= config.bin %> <%= command.id %> <%- config.pjson.oclif.examplePlugin || \"myplugin\" %> "
@@ -4687,7 +4657,8 @@
46874657
"pluginAlias": "@shopify/cli",
46884658
"pluginName": "@shopify/cli",
46894659
"pluginType": "core",
4690-
"strict": true
4660+
"strict": true,
4661+
"summary": "Links a plugin into the CLI for development."
46914662
},
46924663
"plugins:reset": {
46934664
"aliases": [

0 commit comments

Comments
 (0)