This documentation is a reference for:

• VTEX IO CLI default commands
• VTEX plugins commands

VTEX IO CLI 3.x now has a plugin-based architecture, which means that certain commands from earlier versions are now implemented as plugins. These plugins include: add, autoupdate, config, debug, infra, lighthouse, logs, redirects, settings, submit, support, test, and url. Access this link to learn more about VTEX IO CLI plugins.

Below is a brief description of the default commands available in VTEX IO CLI. For detailed information about each command, click on the respective command name. You can also get this information in your terminal by adding --help or -h after the command name.

Command name	Description
autoupdate	Automatically updates VTEX IO CLI.
browse	Opens the URL relative to your current workspace and account in a new browser window.
deploy	Publishes an app as a stable version. Only works for apps previously published as a release candidate version.
deprecate	Deprecates the specified app, uninstalling and downgrading it to the latest stable version on every VTEX account.
deps diff	Displays the differences between the dependencies of two distinct workspaces.
deps list	Displays the complete dependency tree of the current workspace.
deps update	Updates a dependency of the current workspace. If not specified which one, it updates all dependencies.
edition get	Displays the Edition App version installed on the current account.
edition set	Displays the version of the Edition App for the current account.
help	Displays help for VTEX CLI commands.
init	Copies starting files and folders from VTEX boilerplates to your local directories.
install	Installs an app on the current workspace. If no app is specified, it defaults to the app in the current directory.
link	Syncs the app in the current directory with the development workspace being used.
list	Lists the apps installed on the current workspace and account.
local token	Prints the user auth token and copies it to the clipboard.
login	Logs into a VTEX account.
logout	Logs out from the current VTEX account.
publish	Publishes the app in the current directory as a release candidate version.
release	(For git users only.) Bumps the app version, commits, and pushes to remote the app in the current directory.
setup	Sets up typing and tools for the current development environment.
switch	Switches to another VTEX account.
undeprecate	Reverts a deprecated version of an app to a stable version.
uninstall	Uninstalls an app from the current account and workspace.
unlink	Unlinks an app from the current workspace.
update	Updates all installed apps to the latest minor or patch version. Does not upgrade to another major version.
whoami	Prints details about the current account, workspace, environment, and login information.
workspace abtest finish	Stops all A/B tests on the current account.
workspace abtest start	Starts a new A/B test on the current workspace.
workspace abtest status	Displays the results of the active A/B tests.
workspace delete	Deletes one or many workspaces from the current account.
workspace list	Lists all workspaces of the current account.
workspace promote	Promotes the current workspace to master. Only applicable for production workspaces.
workspace reset	Cleans all configurations of the specified workspace and recreates it with the configurations from master.
workspace status	Displays information about the specified workspace.
workspace use	Creates and switches to a new workspace or simply switches to an existing one.

This command refers to the @vtex/cli-plugin-autoupdate plugin. Access this link to learn more about VTEX IO CLI plugins.

Automatically updates VTEX IO CLI.

Usage

Arguments

Argument	Description
CHANNEL (optional)	Channel for which to display the logs.

Opens the URL relative to your current workspace and account in a new browser window.

Usage

Arguments

Argument	Description
PATH (optional)	Relative path from https://{workspace}--{account}.myvtex.com/.

Options

Option	Alias	Description
--qr	-q	Prints a QR Code on the terminal.

Examples

This command refers to the @vtex/cli-plugin-deploy plugin. Access VTEX IO CLI plugins to learn more about the available plugins.

Publishes an app as a stable version. This command only works for apps previously published as a release candidate version [see vtex publish --help].

Usage

Arguments

Argument	Description
APPID (optional)	The name and version of the app you want to deploy.

Options

Option	Alias	Description
--yes	-y	Answers yes to all prompts.
--force	-f	(Use with caution.) Ignores the testing period of 7 minutes after publishing an app.

Examples

Deprecates the specified app, uninstalling and downgrading it to the latest stable version on every VTEX account.

Usage

Arguments

Argument	Description
APPID (optional)	The name and version of the app to deprecate, specified in the format {vendor}.{appname}@{x.x.x}.
ITHAPPID (optional)	The names and versions of multiple apps to deprecate, specified in the format ({vendor}.{appname}@{x.x.x}).

Options

Option	Alias	Description
--yes	-y	Answers yes to all prompts.

Examples

This command refers to the @vtex/cli-plugin-deps plugin. Access VTEX IO CLI plugins to learn more about the available plugins.

Displays the differences between the dependencies of two distinct workspaces. If a single parameter is passed, the command compares the dependencies of the specified workspace with those of the master workspace. If no parameter is passed, the command compares the dependencies of the current workspace with those of the master workspace.

Usage

Arguments

Argument	Description
WORKSPACE1 (optional)	First workspace for comparison.
WORKSPACE2 (optional)	[default: master] Second workspace for comparison.

Example

This command refers to the @vtex/cli-plugin-deps plugin. Access VTEX IO CLI plugins to learn more about the available plugins.

Displays the complete dependency tree of the current workspace.

Usage

Options

Option	Alias	Description
--keys	-k	Shows only key dependencies.
--npm	-n	Includes dependencies from the npm registry.

Alias

Examples

This command refers to the @vtex/cli-plugin-deps plugin. Access VTEX IO CLI plugins to learn more about the available plugins.

Updates a dependency of the current workspace. If not specified which dependency, the command updates all dependencies of the workspace.

Usage

Arguments

Argument	Description
APPID (optional)	The name and version of the app to update, specified in the format {vendor}.{appname}@{x.x.x}.
ITHAPPID (optional)	The names and versions of multiple apps to update, specified in the format ({vendor}.{appname}@{x.x.x}).

Examples

This command refers to the @vtex/cli-plugin-edition plugin. Access VTEX IO CLI plugins to learn more about the available plugins.

Displays the Edition App version installed on the current account.

Usage

Example

This command refers to the @vtex/cli-plugin-edition plugin.Access VTEX IO CLI plugins to learn more about the available plugins.

Sets the Edition App version for the current account.

Usage

Arguments

Argument	Description
EDITION	Name of the Edition App to install.

Example

Displays help for VTEX CLI commands.

Usage

Arguments

Argument	Description
COMMAND (optional)	Command to show help.

Options

Option	Alias	Description
--all	-	Displays all commands available in CLI.

Copies starting files and folders from VTEX boilerplates to your local directories.

Usage

Example

Installs an app on the current workspace. If no app is specified, it defaults to the app in the current directory.

Usage

Arguments

Argument	Description
APPID (optional)	The name and version of the app to install, specified in the format {vendor}.{appname}@{x.x.x}.
ITHAPPID (optional)	The names and versions of multiple apps to install, specified in the format {vendor}.{appname}@{x.x.x}.

Options

Option	Alias	Description
--force	-f	Installs the specified app without checking for route conflicts.

Examples

Syncs the app in the current directory with the development workspace being used.

Usage

Options

Option	Alias	Description
--account=account	-a	Starts a development session in the specified account. Must be used together with the '--workspace' flag.
--clean	-c	Cleans the builder cache.
--setup	-s	Sets up typing definitions before linking the app [see vtex setup --help].
--unsafe	-u	Allows linking the app despite TypeScript errors.
--workspace=workspace	-w	Starts a development session in the specified workspace. It can be used together with the '--account' flag to switch from the current account and workspace.
--no-watch	-	Does not watch for file changes after the initial link.

Example

Lists the apps installed on the current workspace and account.

Usage

Aliases

Examples

Prints the user auth token and copies it to the clipboard.

Usage

Example

Logs into a VTEX account.

Usage

Arguments

Argument	Description
ACCOUNT (optional)	Account name to log in.

Options

Option	Alias	Description
--workspace=workspace	-w	Logs into the specified workspace.

Examples

Logs out from the current VTEX account.

Usage

Example

Publishes the app in the current directory as a release candidate version.

Usage

Options

Option	Alias	Description
--force	-f	Publishes the app independently of SemVer rules.
--tag=tag	-t	Adds the specified tag to the release.
--workspace=workspace	-w	Uses the specified workspace in the app registry.
--yes	-y	Answers yes to all prompts.

Example

(For git users only.) Bumps the app version, commits, and pushes to remote the app in the current directory.

Usage

Arguments

Argument	Description
RELEASETYPE (optional)	Release type (major, minor, or patch).
TAGNAME (optional)	Tag name (e.g., stable, beta).

Examples

Configures typings and tools for the current development environment.

Usage

Options

Option	Alias	Description
--ignore-linked	-i	Configures types from published apps and ignores types from linked apps.
--all	-	Sets all available typings, configurations, and tools.
--tooling	-	Configures Prettier, Husky, and ESLint.
--tsconfig	-	Configures React and Node TSconfig, if applicable.
--typings	-	Configures GraphQL and React typings.

Switches to another VTEX account.

Usage

Arguments

Argument	Description
ACCOUNT	The name of the account to log in to.

Options

Option	Alias	Description
--workspace=workspace	-w	Moves to the specified workspace.

Examples

Reestablishes a deprecated version of an app as a stable version.

Usage

Arguments

Argument	Description
APPID (optional)	The name and version of the app to undeprecate, specified in the format {vendor}.{appname}@{x.x.x}.
ITHAPPID (optional)	The names and versions of multiple apps to undeprecate, specified in the format {vendor}.{appname}@{x.x.x}.

Options

Option	Alias	Description
--yes	-y	Answers yes to all prompts.

Example

Uninstalls an app from the current workspace. If no app is specified to uninstall, it defaults to the app in the current directory.

Usage

Arguments

Argument	Description
APPNAME (optional)	The name and version of the app to uninstall, specified in the format {vendor}.{appname}@{x.x.x}.
ITHAPPNAME (optional)	The names and versions of multiple apps to uninstall, specified in the format {vendor}.{appname}@{x.x.x}.

Options

Option	Alias	Description
--yes	-y	Answers yes to all prompts.

Examples

Unlinks an app from the current workspace. If no app is specified to unlink, it defaults to the app in the current directory.

Usage

appname Name of the app to unlink.

Arguments

Argument	Description
APPID (optional)	The name and version of the app to unlink, specified in the format {vendor}.{appname}@{x.x.x}.
ITHAPPID (optional)	The names and versions of multiple apps to unlink, specified in the format {vendor}.{appname}@{x.x.x}.

Options

Option	Alias	Description
--all	-a	Unlinks all apps.

Examples

Updates all installed apps to the latest, minor, or patch version. Does not upgrade to another major version.

Usage

Example

This command refers to the @vtex/cli-plugin-whoami plugin. Access VTEX IO CLI plugins to learn more about the available plugins.

Prints details about the current account, workspace, environment, and login information.

Usage

Example

This command refers to the @vtex/cli-plugin-abtest plugin. Access this link to learn more about VTEX IO CLI plugins.

Stops all A/B tests from running on the current account.

Usage

This command refers to the @vtex/cli-plugin-abtest plugin. Access VTEX IO CLI plugins to learn more about the available plugins.

Starts a new A/B test on the current workspace.

Usage

This command refers to the @vtex/cli-plugin-abtest plugin. Access VTEX IO CLI plugins to learn more about the available plugins.

Displays the results of active A/B tests.

Usage

Deletes one or many workspaces from the current account.

Usage

Arguments

Argument	Description
WORKSPACE1	Name of the workspace to delete.
ITHWORKSPACE (optional)	Names of multiple workspaces to delete.

Options

Option	Alias	Description
--force	-f	Deletes the specified workspace, even if it is currently being used.
--yes	-y	Answers yes to all prompts.

Examples

Lists all workspaces of the current account.

Usage

Aliases

Examples

Promotes the current workspace to master. It only works for production workspaces.

Usage

Aliases

Examples

Cleans all configurations of the specified workspace and recreates it with the configurations from master.

Usage

Arguments

Argument	Description
WORKSPACENAME (optional)	Name of the workspace to reset.

Options

Option	Alias	Description
--production	-p	Recreates the workspace as a production one.
--yes	-y	Answers yes to all prompts.

Examples

Displays information about the specified workspace.

Usage

Arguments

Argument	Description
WORKSPACENAME (optional)	Name of the workspace.

Example

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

Usage

Arguments

Argument	Description
WORKSPACE	Name of the workspace to use.

Options

Option	Alias	Description
--production	-p	Creates and/or switches to a production workspace.
--reset	-r	Resets the workspace before switching to it.

Aliases

Examples

Below is a brief description of the commands provided by VTEX plugins. For detailed information about each command, click its respective name. After installing the corresponding plugin, you can also access this information in your terminal by adding --help or -h after the command name.

Access VTEX IO CLI plugin to learn more about the available plugins.

Plugin command	Description
add	Adds the specified app(s) to the manifest dependencies.
config get	Prints the value of the requested configuration key.
config reset	Resets the specified configuration to its default value.
config set	Sets the value of a configuration key.
debug dotnet	Debugs .NET applications (IDEs only).
infra install	Installs an infra service.
infra list	Lists installed infra services.
infra update	Updates all installed infra services.
lighthouse audit	Runs a Lighthouse audit over the specified URL.
lighthouse show	Shows a previous audit report, filtered by app and/or URL.
logs	Shows logs of an app (only apps in production).
plugins install	Installs a plugin on CLI.
plugins link	Links a plugin to CLI for development.
plugins:list	Lists all plugins installed on your machine.
plugins source	Lists all plugins supported by VTEX.
plugins uninstall	Removes a plugin from CLI.
plugins:update	Updates all plugins installed on your machine.
redirects delete	Deletes redirects from the current account and workspace.
redirects export	Exports all redirects defined in the current account and workspace to a CSV file.
redirects import	Imports redirects from a CSV file to the current account and workspace.
settings get	Prints the settings of the specified app.
settings set	Sets value to the specified setting of an app.
settings unset	Disables the specified setting of an app.
submit	Submits the current app, or a specified one, for validation by the VTEX App Store team.
support	Logs in as support to another VTEX account.
test e2e	Runs E2E integration tests for the app in the current directory.
test unit	Runs unit tests for the app in the current directory.
url	Prints the base URL for the current account and workspace.

Adds the specified app(s) to the manifest dependencies.

Usage

Arguments

Argument	Description
APPID	The name and version of the dependency to include in the manifest.json file, specified in the format {vendor}.{appname}@{x.x.x}.
ITHAPPID (optional)	The names and versions of multiple dependencies to include in the manifest.json file, specified in the format {vendor}.{appname}@{x.x.x}.

Example

Automatically updates VTEX IO CLI.

Usage

Arguments

Argument	Description
CHANNEL (optional)	.

Prints the value of the requested configuration key.

Usage

Arguments

Argument	Description
CONFIGNAME	Configuration to retrieve the value from.

Example

Resets the specified configuration to its default value.

Usage

Arguments

Argument	Description
CONFIGNAME	Name of the configuration to reset.

Example

Sets the value of a configuration key.

Usage

Arguments

Argument	Description
CONFIGNAME	Name of the configuration.
VALUE	New value of the specified configuration.

Example

Debugs .NET applications (IDEs only).

Usage

Arguments

Argument	Description
DEBUGINST	Name of the .NET application to debug.

Installs an infra service.

Usage

Arguments

Argument	Description
SERVICEID	The name and version of the service to install, specified in the format {vendor}.{servicename}@{x.x.x}.

Examples

Lists installed infra services.

Usage

Arguments

Argument	Description
NAME (optional)	Service name.

Options

Option	Alias	Description
--available	-a	Lists services that are available to install.
--filter=filter	-f	Lists services that contain the specified word.

Aliases

Examples

Updates all installed infra services.

Usage

Example

Runs a Lighthouse audit over the specified URL.

Usage

Arguments

Argument	Description
URL	URL to audit.

Options

Option	Alias	Description
--json	-j	Returns the report as a JSON on stdout.

Aliases

Examples

Shows a previous audit report, filtering by app and/or URL.

Usage

Options

Option	Alias	Description
--app=app	-a	Filters by app name.
--url=url	-u	Filters by URL.

Aliases

Examples

Shows logs of an app. (Only apps in production.)

Usage

Arguments

Argument	Description
APP (optional)	Name of the app to show logs.

Options

Option	Alias	Description
--all	-a	Shows logs of all apps installed on the current account.
--past	-p	Shows previous logs of the specified app.

Examples

Installs a plugin on the CLI.

Usage

Arguments

Argument	Description
PLUGIN	Plugin to install.

Options

Option	Alias	Description
--force	-f	Refetches all packages, even the ones that were previously installed.

Aliases

Examples

Links a plugin to CLI for development.

Usage

Arguments

Argument	Description
PATH [default: .]	Plugin path.

Examples

Lists all plugins installed on your machine.

Usage

Options

Option	Description
--core	Shows core plugins.

Examples

Lists all plugins supported by VTEX.

Usage

Arguments

Argument	Description
PLUGIN	Plugin name.
PATH [default: .]	Plugin path.

Examples

Removes a plugin from CLI.

Usage

Arguments

Argument	Description
PLUGIN	Plugin to uninstall.

Aliases

Examples

Updates all plugins installed on your machine.

Usage

Deletes redirects from the current account and workspace.

Usage

Arguments

Argument	Description
CSVPATH	CSV file containing the URL paths to delete.

Example

Exports all redirects defined in the current account and workspace to a CSV file.

Usage

Arguments

Argument	Description
CSVPATH	Name of the CSV file.

Example

Imports redirects from a CSV file to the current account and workspace.

Usage

Options

Option	Alias	Description
--reset	-r	Removes all previously defined redirects.

Example

Prints the settings of the specified app.

Usage

Arguments

Argument	Description
APNAME	Name of the app to check the available settings.
FIELD (optional)	Name of the setting.

Aliases

Example

Sets the value for the specified setting of an app.

Usage

Arguments

Argument	Description
APPNAME	Name of the app.
FIELD	Name of the setting.
VALUE	Value of the setting.

Example

Disables the specified setting of an app.

Usage

Arguments

Argument	Description
APPNAME	Name of the app.
FIELD	Name of the setting.

Example

Submits the current app, or a specified one, for validation by the VTEX App Store team.

Usage

Arguments

Argument	Description
APPID (optional)	The name of the app to validate.

Examples

Logs in as support to another VTEX account.

Usage

Arguments

Argument	Description
ACCOUNT	Name of the account to give support.

Example

Runs E2E integration tests for the app in the current directory.

Usage

Options

Option	Alias	Description
--report=report	-r	Displays the results and state of the specified test ID.
--token	-t	(Not recommended.) Sends your personal authorization token to your testing session, making it available during the tests. Please note that this action can be potentially dangerous as it exposes your token through the 'authToken' environment variable.
--workspace	-w	Runs tests for the apps installed on the specified workspace.

Runs unit tests for the app in the current directory.

Usage

Options

Option	Alias	Description
--unsafe	-u	Ignores TypeScript errors

Prints the base URL for the current account, workspace, and environment.

Usage

Example