VTEX CLI Plugin Workspace

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

Usage

$ npm install -g @vtex/cli-plugin-workspace
$ oclif-example COMMAND
running command...
$ oclif-example (-v|--version|version)
@vtex/cli-plugin-workspace/1.2.0 darwin-arm64 node-v16.13.0
$ oclif-example --help [COMMAND]
USAGE
  $ oclif-example COMMAND
...

Commands

• oclif-example workspace:delete WORKSPACE1 [ITHWORKSPACE]
• oclif-example workspace:list
• oclif-example workspace:promote
• oclif-example workspace:reset [WORKSPACENAME]
• oclif-example workspace:status [WORKSPACENAME]
• oclif-example workspace:use WORKSPACE

oclif-example workspace:delete WORKSPACE1 [ITHWORKSPACE]

Deletes one or many workspaces from the current account.

USAGE
  $ oclif-example workspace:delete WORKSPACE1 [ITHWORKSPACE]

ARGUMENTS
  WORKSPACE1    Name of the workspace to delete.
  ITHWORKSPACE  Name of the multiple workspaces to delete.

OPTIONS
  -f, --force    Deletes the specified workspace even if it is currently in use.
  -h, --help     Shows this help message.
  -v, --verbose  Shows debug level logs.
  -y, --yes      Answers yes to all prompts.
  --trace        Ensures all requests to VTEX IO are traced.

EXAMPLES
  vtex workspace delete workspaceName
  vtex workspace delete workspaceName1 workspaceName2

See code: build/commands/workspace/delete.ts

oclif-example workspace:list

Lists all workspaces of the current account.

USAGE
  $ oclif-example workspace:list

OPTIONS
  -h, --help     Shows this help message.
  -v, --verbose  Shows debug level logs.
  --trace        Ensures all requests to VTEX IO are traced.

ALIASES
  $ oclif-example workspace:ls

EXAMPLES
  vtex workspace list
  vtex workspace ls

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

oclif-example workspace:promote

Promotes the current workspace to master. (Only works for production workspaces.) Run vtex promote --help to see how to deal with data conflicts.

USAGE
  $ oclif-example workspace:promote

OPTIONS
  -h, --help
      Shows this help message.

  -v, --verbose
      Shows debug level logs.

  --conflict=master|mine|abort
      [default: master] Defines how to handle data conflict between workspaces.
      - master: Discards the workspace's conflicting data, keeping the data from master unchanged.
      - mine: Overrides the master with the specified workspace. Any conflicting data on the master is lost.
      - abort: Aborts the workspace promotion in case of data conflict.

  --trace
      Ensures all requests to VTEX IO are traced.

ALIASES
  $ oclif-example promote

EXAMPLES
  vtex workspace promote
  vtex promote

See code: build/commands/workspace/promote.ts

oclif-example workspace:reset [WORKSPACENAME]

Cleans all configurations of a workspace and recreates it with the configurations from master. If not specified which workspace, it defaults to the current one.

USAGE
  $ oclif-example workspace:reset [WORKSPACENAME]

ARGUMENTS
  WORKSPACENAME  Name of the workspace to reset.

OPTIONS
  -h, --help        Shows this help message.
  -p, --production  Recreates the workspace as a production one.
  -v, --verbose     Shows debug level logs.
  -y, --yes         Answers yes to all prompts.
  --trace           Ensures all requests to VTEX IO are traced.

EXAMPLES
  vtex workspace reset
  vtex workspace reset workspaceName

See code: build/commands/workspace/reset.ts

oclif-example workspace:status [WORKSPACENAME]

Displays information about the specified workspace.

USAGE
  $ oclif-example workspace:status [WORKSPACENAME]

ARGUMENTS
  WORKSPACENAME  Name of the workspace.

OPTIONS
  -h, --help     Shows this help message.
  -v, --verbose  Shows debug level logs.
  --trace        Ensures all requests to VTEX IO are traced.

EXAMPLE
  vtex workspace status

See code: build/commands/workspace/status.ts

oclif-example workspace:use WORKSPACE

Creates and switches to a new workspace or simply switches to an existing one.

USAGE
  $ oclif-example workspace:use WORKSPACE

ARGUMENTS
  WORKSPACE  Name of the workspace

OPTIONS
  -h, --help        Shows this help message.
  -p, --production  Creates and/or switches to a production workspace.
  -r, --reset       Resets the workspace before switching to it.
  -v, --verbose     Shows debug level logs.
  --trace           Ensures all requests to VTEX IO are traced.

ALIASES
  $ oclif-example use

EXAMPLES
  vtex workspace use workspaceName
  vtex use workspaceName

See code: build/commands/workspace/use.ts