Skip to content

vtex/cli-plugin-deploy

Repository files navigation

VTEX CLI Plugin Deploy

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.

oclif npm

Usage

$ npm install -g @vtex/cli-plugin-deploy
$ vtex COMMAND
running command...
$ vtex (-v|--version|version)
@vtex/cli-plugin-deploy/0.3.1 linux-x64 node-v12.21.0
$ vtex --help [COMMAND]
USAGE
  $ vtex COMMAND
...

Commands

vtex deploy [APPID]

Publishes an app as a stable version. Only works for apps previously published as a release candidate [see mvtex publish --help].

USAGE
  $ vtex deploy [APPID]

ARGUMENTS
  APPID  Name and version of the app ({vendor}.{appname}@{x.x.x}) you want to deploy.

OPTIONS
  -f, --force    Ignores the testing period of 7 minutes after publishing an app. (Use with caution.)
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  -y, --yes      Answers yes to all prompts.
  --trace        Ensure all requests to VTEX IO are traced

EXAMPLES
  vtex deploy
  vtex deploy vtex.service-example@0.0.1

See code: build/commands/deploy.ts