VTEX CLI Plugin Deps

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 Deps
• Usage
• Commands

Usage

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

Commands

• oclif-example deps:diff [WORKSPACE1] [WORKSPACE2]
• oclif-example deps:list
• oclif-example deps:update [APPID] [ITHAPPID]

oclif-example deps:diff [WORKSPACE1] [WORKSPACE2]

Displays the differences between the dependencies of two distinct workspaces. If a single parameter is passed, the specified workspace's dependencies are compared with the master's. If no parameter is passed, the diff is made between the current workspace and master.

USAGE
  $ oclif-example deps:diff [WORKSPACE1] [WORKSPACE2]

ARGUMENTS
  WORKSPACE1  First workspace for comparison.
  WORKSPACE2  [default: master] Second workspace for comparison.

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

EXAMPLE
  vtex deps diff workspace1 workspace2

See code: build/commands/deps/diff.ts

oclif-example deps:list

Displays the complete dependency tree of the current workspace.

USAGE
  $ oclif-example deps:list

OPTIONS
  -h, --help     show CLI help
  -k, --keys     Shows only key dependencies.
  -n, --npm      Includes dependencies from npm registry.
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

ALIASES
  $ oclif-example deps:ls

EXAMPLES
  vtex deps list
  vtex deps ls

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

oclif-example deps:update [APPID] [ITHAPPID]

Updates a dependency of the current workspace. If not specified which dependency, it updates all of them.

USAGE
  $ oclif-example deps:update [APPID] [ITHAPPID]

ARGUMENTS
  APPID     Name and version of the app ({vendor}.{appname}@{x.x.x}) to update.
  ITHAPPID  Names and versions of the multiple apps ({vendor}.{appname}@{x.x.x}) to update.

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

EXAMPLES
  vtex deps update
  vtex deps update [email protected]

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