Skip to content

Commit 85ddb3f

Browse files
committed
Updates documentation regarding installation and usage of this plugin
1 parent ed6d4b7 commit 85ddb3f

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,30 +25,33 @@ For more information, read [Ocliff Docs](https://oclif.io/docs/introduction).
2525
# Usage
2626
<!-- usage -->
2727
```sh-session
28-
$ npm install -g @vtex/cli-plugin-infra
29-
$ vtex COMMAND
30-
running command...
31-
$ vtex (-v|--version|version)
32-
@vtex/cli-plugin-infra/1.0.0 linux-x64 node-v12.22.1
33-
$ vtex --help [COMMAND]
28+
$ vtex plugins install infra
29+
$ vtex infra --help
30+
Installs, updates, or lists infra services. Run 'vtex infra' to see all 3 subcommands
31+
3432
USAGE
35-
$ vtex COMMAND
33+
$ vtex infra COMMAND
34+
35+
COMMANDS
36+
infra install Installs an infra service.
37+
infra list Lists installed infra services.
38+
infra update Updates all installed infra services.
3639
...
3740
```
3841
<!-- usagestop -->
3942
# Commands
4043
<!-- commands -->
41-
* [`vtex infra:install SERVICEID`](#vtex-infrainstall-serviceid)
42-
* [`vtex infra:list [NAME]`](#vtex-infralist-name)
43-
* [`vtex infra:update`](#vtex-infraupdate)
44+
* [`vtex infra install SERVICEID`](#vtex-infrainstall-serviceid)
45+
* [`vtex infra list [NAME]`](#vtex-infralist-name)
46+
* [`vtex infra update`](#vtex-infraupdate)
4447

45-
## `vtex infra:install SERVICEID`
48+
## `vtex infra install SERVICEID`
4649

4750
Installs an infra service.
4851

4952
```
5053
USAGE
51-
$ vtex infra:install SERVICEID
54+
$ vtex infra install SERVICEID
5255
5356
ARGUMENTS
5457
SERVICEID Name and version of the service ({vendor}.{servicename}@{x.x.x}) to install.
@@ -71,7 +74,7 @@ Lists installed infra services.
7174

7275
```
7376
USAGE
74-
$ vtex infra:list [NAME]
77+
$ vtex infra list [NAME]
7578
7679
ARGUMENTS
7780
NAME Service name.
@@ -84,7 +87,7 @@ OPTIONS
8487
--trace Ensure all requests to VTEX IO are traced
8588
8689
ALIASES
87-
$ vtex infra:ls
90+
$ vtex infra ls
8891
8992
EXAMPLES
9093
vtex infra list
@@ -99,7 +102,7 @@ Updates all installed infra services.
99102

100103
```
101104
USAGE
102-
$ vtex infra:update
105+
$ vtex infra update
103106
104107
OPTIONS
105108
-h, --help show CLI help

0 commit comments

Comments
 (0)