Documentation
Feedback
Guides

VTEX IO CLI
Managing plugins

VTEX IO CLI 3.x has a plug-in architecture that makes it more flexible and extensible to inject new commands and functionalities. This way, you can go beyond VTEX IO's CLI default commands and add specific plugins to achieve a more comprehensive experience.

Check the Command Reference for a detailed description of all plugins developed by VTEX.

The following plugins are native to VTEX IO'S CLI. Therefore, you do not need to install them: abtest, autoupdate, deploy, deps, edition, plugins, whoami, workspace.

Checking plugin commands

Check all commands related to plugins by running the following command.

vtex plugins

{"base64":"  ","img":{"width":2206,"height":1054,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":221665,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-plugins-0.png"}}

Listing all VTEX plugins

List all plugins available by VTEX by running the following command.

vtex plugins source

{"base64":"  ","img":{"width":2206,"height":1028,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":181639,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-plugins-1.png"}}

If you already have downloaded a plugin, it will be highlighted in green.

Installing a plugin

Install a new plugin by running the following command.

vtex plugins install {pluginName}

Replace the value between curly brackets with the name of the plugin you want to install.

  • For vtex plugins, use just the plugin name. For example, vtex plugins install infra.

    Tip: you can run vtex plugins source to check the available VTEX plugins.

  • For third parties plugins, use the following format: @{org-name}/{plugin-name}.

{"base64":"  ","img":{"width":2206,"height":574,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":125783,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-plugins-2.png"}}

Listing installed plugins

List all plugins installed in your machine by running the following command.

vtex plugins list

{"base64":"  ","img":{"width":2206,"height":608,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":130759,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-plugins-3.png"}}

Updating installed plugins

Update all plugins installed in your machine by running the following command.

vtex plugins update

{"base64":"  ","img":{"width":2206,"height":574,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":117781,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-plugins-4.png"}}

Uninstalling a plugin

Delete a plugin from your machine by running the following command.

vtex plugins uninstall {pluginName}

️ Replace the value between curly brackets with the name of the plugin you want to uninstall. You can run vtex plugins list to check which plugins are installed in your machine.

{"base64":"  ","img":{"width":2206,"height":574,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":119488,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-plugins-5.png"}}

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page