# @vtex/cli-plugin-workspace > vtex plugin workspace Latest version **1.2.0** (published 2024-10-29) · MIT license · 0 weekly downloads ## Install ```sh npm install @vtex/cli-plugin-workspace pnpm add @vtex/cli-plugin-workspace yarn add @vtex/cli-plugin-workspace bun add @vtex/cli-plugin-workspace ``` ## Health **Score 35/100 (D)** — status: stable. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: stale. ## Facts | | | |---|---| | Version | 1.2.0 | | Published | 2024-10-29 | | First published | 2020-08-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=8.0.0 | | Dependencies | 7 | | Unpacked size | 40.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Maintainers | rodzac, kevinvtex, daniyelnnr, iago1501, carolinerpessoa, luiznickel-vtex, marcos_vtex, jardelymaris, denissilvavtex, eduardocesb, enzomerca, vinhags, zaedyvtex, filafb, bastotec, arthurtriis1vtex, geraldo.fernandes, georgebrindeiro, filipewl, emersonvtex, rodrigo.albuquerque, viniciuslouzadavtex, npedrosovtex, myllena.alves, mendescamara, mauro.takeda, lpolon, gianvittorio, eduardoformiga, vcnovaes, dpzvtex, vtexlab-user, wender, natamelo, mayzabel, augusto.lazaro, rafarubim, gustavorosolem, arthurepc, jeymisson, victorhmp, lurian, arturpimentel, anitavincent, brunojdo, lucasecdb, matheusps, emersonlaurentino, viniagostini, lucasaarcoverde, lariciamota, icazevedo, fabits, mateuspontes, gmantiqueira, vitorlgomes, rodolfoams, policarpo, marcelovicentegc, maianabt, jeffersontuc, hiagolcm, william.silva | | Keywords | oclif-plugin | ## Links - npm: https://www.npmjs.com/package/@vtex/cli-plugin-workspace - Repository: https://github.com/vtex/cli-plugin-workspace - Issues: https://github.com/vtex/cli-plugin-workspace/issues - npm.io page: https://npm.io/package/@vtex/cli-plugin-workspace ## Dependencies (7) - [ora](https://npm.io/package/ora.md) 4.0.4 - [boxen](https://npm.io/package/boxen.md) 4.2.0 - [ramda](https://npm.io/package/ramda.md) ^0.27.1 - [tslib](https://npm.io/package/tslib.md) ^1 - [@vtex/api](https://npm.io/package/@vtex/api.md) npm:@vtex/api@6.48.0 - [@oclif/config](https://npm.io/package/@oclif/config.md) ^1 - [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.8.0 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 1.2.0 (latest) — 2024-10-29 - 1.1.6-beta.3 (beta) — 2024-10-29 - 1.1.6-beta.2 — 2024-10-29 - 1.1.6-beta.0 — 2024-10-29 - 1.1.6 — 2024-10-29 - 1.1.5 — 2024-10-29 - 1.1.5-beta.1 — 2024-10-28 - 1.1.5-beta.0 — 2024-10-28 - 1.1.4 — 2024-10-24 - 1.1.4-beta.0 — 2024-10-24 - 1.1.3 — 2024-10-24 - 1.1.2 — 2024-10-24 - 1.1.1 — 2024-10-24 - 1.1.0 — 2024-10-24 - 1.0.1 — 2021-03-30 - … 36 more at https://npm.io/package/@vtex/cli-plugin-workspace/versions ## README # 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`. 2. Run `yarn link` on this project. 3. Now run `vtex link @vtex/cli-plugin-template` (or the new name) on the `vtex/toolbelt` project. 4. Run `yarn watch` on the `vtex/toolbelt` 5. Test the command on a VTEX IO app with `vtex-test hello` For more information, read [Ocliff Docs](https://oclif.io/docs/introduction). [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) ![npm](https://img.shields.io/npm/v/@vtex/cli-plugin-workspace) * [VTEX CLI Plugin Workspace](#vtex-cli-plugin-workspace) * [Usage](#usage) * [Commands](#commands) # Usage ```sh-session $ 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-workspacedelete-workspace1-ithworkspace) * [`oclif-example workspace:list`](#oclif-example-workspacelist) * [`oclif-example workspace:promote`](#oclif-example-workspacepromote) * [`oclif-example workspace:reset [WORKSPACENAME]`](#oclif-example-workspacereset-workspacename) * [`oclif-example workspace:status [WORKSPACENAME]`](#oclif-example-workspacestatus-workspacename) * [`oclif-example workspace:use WORKSPACE`](#oclif-example-workspaceuse-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](https://github.com/vtex/cli-plugin-workspace/blob/v1.2.0/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](https://github.com/vtex/cli-plugin-workspace/blob/v1.2.0/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](https://github.com/vtex/cli-plugin-workspace/blob/v1.2.0/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](https://github.com/vtex/cli-plugin-workspace/blob/v1.2.0/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](https://github.com/vtex/cli-plugin-workspace/blob/v1.2.0/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](https://github.com/vtex/cli-plugin-workspace/blob/v1.2.0/build/commands/workspace/use.ts)_ --- _Source: https://npm.io/package/@vtex/cli-plugin-workspace · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._