Skip to content

Commit

Permalink
Updates documentation regarding installation and usage of this plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
juliobguedes committed Sep 13, 2024
1 parent ed6d4b7 commit 85ddb3f
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,33 @@ For more information, read [Ocliff Docs](https://oclif.io/docs/introduction).
# Usage
<!-- usage -->
```sh-session
$ npm install -g @vtex/cli-plugin-infra
$ vtex COMMAND
running command...
$ vtex (-v|--version|version)
@vtex/cli-plugin-infra/1.0.0 linux-x64 node-v12.22.1
$ vtex --help [COMMAND]
$ vtex plugins install infra
$ vtex infra --help
Installs, updates, or lists infra services. Run 'vtex infra' to see all 3 subcommands

USAGE
$ vtex COMMAND
$ vtex infra COMMAND

COMMANDS
infra install Installs an infra service.
infra list Lists installed infra services.
infra update Updates all installed infra services.
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`vtex infra:install SERVICEID`](#vtex-infrainstall-serviceid)
* [`vtex infra:list [NAME]`](#vtex-infralist-name)
* [`vtex infra:update`](#vtex-infraupdate)
* [`vtex infra install SERVICEID`](#vtex-infrainstall-serviceid)
* [`vtex infra list [NAME]`](#vtex-infralist-name)
* [`vtex infra update`](#vtex-infraupdate)

## `vtex infra:install SERVICEID`
## `vtex infra install SERVICEID`

Installs an infra service.

```
USAGE
$ vtex infra:install SERVICEID
$ vtex infra install SERVICEID
ARGUMENTS
SERVICEID Name and version of the service ({vendor}.{servicename}@{x.x.x}) to install.
Expand All @@ -71,7 +74,7 @@ Lists installed infra services.

```
USAGE
$ vtex infra:list [NAME]
$ vtex infra list [NAME]
ARGUMENTS
NAME Service name.
Expand All @@ -84,7 +87,7 @@ OPTIONS
--trace Ensure all requests to VTEX IO are traced
ALIASES
$ vtex infra:ls
$ vtex infra ls
EXAMPLES
vtex infra list
Expand All @@ -99,7 +102,7 @@ Updates all installed infra services.

```
USAGE
$ vtex infra:update
$ vtex infra update
OPTIONS
-h, --help show CLI help
Expand Down

0 comments on commit 85ddb3f

Please sign in to comment.