VTEX CLI Plugin Template

Extend the vtex toolbelt!

Developing

1. Clone vtex/toolbelt and follow the steps on the Contributing section.
2. Clone/Create a plugin with this template.
3. Change the template name under this project's package.json.
4. Run yarn link on this project.
5. Now run vtex link @vtex/cli-plugin-template (or the new name) on the vtex/toolbelt project.
6. Run yarn watch on the vtex/toolbelt
7. Test the command on a VTEX IO app with vtex-test hello

For more information, read Ocliff Docs.

• VTEX CLI Plugin Template
• Usage
• Commands

Usage

$ 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.12
$ vtex --help [COMMAND]
USAGE
  $ vtex COMMAND
...

Commands

• vtex infra:install SERVICEID
• vtex infra:list [NAME]
• vtex infra:update

vtex infra:install SERVICEID

Installs an infra service.

USAGE
  $ vtex infra:install SERVICEID

ARGUMENTS
  SERVICEID  Name and version of the service ({vendor}.{servicename}@{x.x.x}) to install.

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

EXAMPLES
  vtex infra install infra-service
  vtex infra install infra-service@0.0.1

See code: build/commands/infra/install.ts

vtex infra:list [NAME]

Lists installed infra services.

USAGE
  $ vtex infra:list [NAME]

ARGUMENTS
  NAME  Service name.

OPTIONS
  -a, --available      Lists services that are available to install.
  -f, --filter=filter  Lists services that contain the specified word.
  -h, --help           show CLI help
  -v, --verbose        Show debug level logs
  --trace              Ensure all requests to VTEX IO are traced

ALIASES
  $ vtex infra:ls

EXAMPLES
  vtex infra list
  vtex infra ls

See code: build/commands/infra/list.ts

vtex infra:update

Updates all installed infra services.

USAGE
  $ vtex infra:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

EXAMPLE
  vtex infra update

See code: build/commands/infra/update.ts