VTEX Developer Portal

This documentation is a reference for:

⚠

️ VTEX IO's CLI 3.x now has a plugin-based architecture. Hence, some commands from the previous versions of VTEX IO's CLI are now available as plugins. They are: add, autoupdate, config, debug, infra, lighthouse, logs, redirects, settings, submit, support, test, url. Follow this link this link to learn more about VTEX IO's CLI plugins.

Default commands

Check in the following a brief description of the default commands of VTEX IO's CLI. For a detailed description of each command, click on its respective name. You can also access this information in your terminal by adding --help or -h after the command name.

Command NameFunctionality
autoupdateAutomatically updates VTEX IO's CLI.
browseOpens the URL relative to your current workspace and account in a new browser window.
deployPublishes an app as a stable version. Only works for apps previously published as a release candidate version.
deprecateDeprecates the specified app, uninstalling and downgrading it to the latest stable version in every VTEX account.
deps diffDisplays the differences between the dependencies of two distinct workspaces.
deps listDisplays the complete dependency tree of the current workspace.
deps updateUpdates a dependency of the current workspace. If not specified which one, it updates all dependencies.
edition getDisplays the Edition App version installed on the current account.
edition setSets the Edition App version for the current account.
helpDisplays help for VTEX CLI commands.
initCopies starting files and folders from VTEX boilerplates into your local directories.
installInstalls an app on the current workspace. If not specified which one, it defaults to the app in the current directory.
linkSyncs the app in the current directory with the development workspace in use.
listLists the apps installed on the current workspace and account.
local tokenPrints the user's auth token and copies it to the clipboard.
loginLogs in to a VTEX account.
logoutLogs out of the current VTEX account.
publishPublishes the app in the current directory as a release candidate version.
release(Only for git users.) Bumps the app version, commits, and pushes to remote the app in the current directory.
setupSets up typings and tools for the current development environment.
switchSwitches to another VTEX account.
undeprecateReestablishes a deprecated version of an app as a stable version.
uninstallUninstalls an app from the current account and workspace.
unlinkUnlinks an app from the current workspace.
updateUpdates all installed apps to the latest (minor or patch) version. Does not upgrade to another major version.
whoamiPrints the current account, workspace, environment, and login details.
workspace abtest finishStops all A/B tests from running on the current account.
workspace abtest startStarts a new A/B test on the current workspace.
workspace abtest statusDisplays the results of the active A/B tests.
workspace deleteDeletes one or many workspaces from the current account.
workspace listLists all workspaces of the current account.
workspace promotePromotes the current workspace to master. Only works for production workspaces
workspace resetCleans all configurations of the specified workspace and recreates it with the configurations from master.
workspace statusDisplays information about the specified workspace.
workspace useCreates and switches to a new workspace or simply switches to an existing one.
🔼 Back

autoupdate

ℹ

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

Automatically updates VTEX IO's CLI.

Usage

  $ vtex autoupdate [CHANNEL]

Arguments

ArgumentDescription
CHANNEL (optional).
🔼 Back

browse

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

Usage

  $ vtex browse [PATH]

Arguments

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

Options

OptionAliasDescription
--qr-qPrints a QR Code on the terminal.

Examples

  vtex browse
  vtex browse admin
🔼 Back

deploy

ℹ

️ This command refers to the plugin @vtex/cli-plugin-deploy. Follow this link this link to learn more about VTEX IO's CLI plugins.

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

Usage

  $ vtex deploy [APPID]

Arguments

ArgumentDescription
APPID (optional)Name and version of the app you want to deploy.

Options

OptionAliasDescription
--yes-yAnswers yes to all prompts.
--force-f(Use with caution.) Ignores the testing period of 7 minutes after publishing an app.

Examples

  vtex deploy
  vtex deploy [email protected]
🔼 Back

deprecate

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

Usage

  $ vtex deprecate [APPID] [ITHAPPID]

Arguments

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

Options

OptionAliasDescription
--yes-yAnswers yes to all prompts.

Examples

  vtex deprecate
  vtex deprecate [email protected]
🔼 Back

deps diff

ℹ

️ This command refers to the plugin @vtex/cli-plugin-deps. Follow this link this link to learn more about VTEX IO's CLI plugins.

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

  $ vtex deps diff [WORKSPACE1] [WORKSPACE2]

Arguments

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

Example

  vtex deps diff workspace1 workspace2
🔼 Back

deps list

ℹ

️ This command refers to the plugin @vtex/cli-plugin-deps. Follow this link this link to learn more about VTEX IO's CLI plugins.

Displays the complete dependency tree of the current workspace.

Usage

  $ vtex deps list

Options

OptionAliasDescription
--keys-kShows only key dependencies.
--npm-nIncludes dependencies from the npm registry.

Alias

  $ vtex deps ls

Examples

  vtex deps list
  vtex deps ls
🔼 Back

deps update

ℹ

️ This command refers to the plugin @vtex/cli-plugin-deps. Follow this link this link to learn more about VTEX IO's CLI plugins.

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

Usage

  $ vtex deps update [APPID] [ITHAPPID]

Arguments

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

Examples

  vtex deps update
  vtex deps update [email protected]
🔼 Back

edition get

ℹ

️ This command refers to the plugin @vtex/cli-plugin-edition. Follow this link this link to learn more about VTEX IO's CLI plugins.

Displays the Edition App version installed on the current account.

Usage

  $ vtex edition get

Example

  vtex edition get
🔼 Back

edition set

ℹ

️ This command refers to the plugin @vtex/cli-plugin-edition. Follow this link this link to learn more about VTEX IO's CLI plugins.

Sets the Edition App version for the current account.

Usage

  $ vtex edition set EDITION

Arguments

ArgumentDescription
EDITIONName of the Edition App to install.

Example

  vtex edition set editionName
🔼 Back

help

Displays help for VTEX CLI commands.

Usage

  $ vtex help [COMMAND]

Arguments

ArgumentDescription
COMMAND (optional)Command to show help about.

Options

OptionAliasDescription
--all-Displays all commands available in the CLI.
🔼 Back

init

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

Usage

  $ vtex init

Example

  vtex init
🔼 Back

install

Installs an app on the current workspace. If not specified which one, it defaults to the app in the current directory.

Usage

  $ vtex install [APPID] [ITHAPPID]

Arguments

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

Options

OptionAliasDescription
--force-fInstalls the specified app without checking for route conflicts.

Examples

  vtex install
  vtex install [email protected]
  vtex install [email protected]
🔼 Back

link

Syncs the app in the current directory with the development workspace in use.

Usage

  $ vtex link

Options

OptionAliasDescription
--account=account-aStarts a development session in the specified account. Must be paired with the '--workspace' flag.
--clean-cCleans builder cache.
--setup-sSets up typing definitions before linking the app [see vtex setup --help].
--unsafe-uAllows linking the app despite Typescript errors.
--workspace=workspace-wStarts a development session in the specified workspace. Can be paired with the '--account' flag to switch from the current account and workspace.
--no-watch-Doesn't watch for file changes after the initial link.

Example

  vtex link -a youraccount -w yourworkspace
🔼 Back

list

Lists the apps installed on the current workspace and account.

Usage

  $ vtex list

Aliases

  $ vtex ls

Examples

  vtex list
  vtex ls
🔼 Back

local token

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

Usage

  $ vtex local token

Example

  vtex local token
🔼 Back

login

Logs in to a VTEX account.

Usage

  $ vtex login [ACCOUNT]

Arguments

ArgumentDescription
ACCOUNT (optional)Account name to log in.

Options

OptionAliasDescription
--workspace=workspace-wLogs in the specified workspace.

Examples

  vtex login
  vtex login storecomponents
🔼 Back

logout

Logs out of the current VTEX account.

Usage

  $ vtex logout

Example

  vtex logout
🔼 Back

publish

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

Usage

  $ vtex publish

Options

OptionAliasDescription
--force-fPublishes the app independently of SemVer rules.
--tag=tag-tAdds the specified tag to the release.
--workspace=workspace-wUses the specified workspace in the app registry.
--yes-yAnswers yes to all prompts.

Example

  vtex publish
🔼 Back

release

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

Usage

  $ vtex release [RELEASETYPE] [TAGNAME]

Arguments

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

Examples

  vtex release
  vtex release patch
  vtex release patch beta
  vtex release minor stable
  vtex release pre
🔼 Back

setup

Sets up typings and tools for the current development environment.

Usage

  $ vtex setup

Options

OptionAliasDescription
--ignore-linked-iSets up types from published apps, and ignores types from linked apps.
--all-Sets up all available typings, configs, and tools.
--tooling-Sets up Prettier, Husky, and ESLint.
--tsconfig-Sets up React and Node TSconfig, if applicable.
--typings-Sets up GraphQL and React typings.
🔼 Back

switch

Switches to another VTEX account.

Usage

  $ vtex switch ACCOUNT

Arguments

ArgumentDescription
ACCOUNTAccount name to log in.

Options

OptionAliasDescription
--workspace=workspace-wMoves to the specified workspace.

Examples

  vtex switch storecomponents
🔼 Back

undeprecate

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

Usage

  $ vtex undeprecate [APPID] [ITHAPPID]

Arguments

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

Options

OptionAliasDescription
--yes-yAnswers yes to all prompts.

Example

  vtex undeprecate [email protected]
🔼 Back

uninstall

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

Usage

  $ vtex uninstall [APPNAME] [ITHAPPNAME]

Arguments

ArgumentDescription
APPNAME (optional)Name and version of the app ({vendor}.{appname}@{x.x.x}) to uninstall.
ITHAPPNAME (optional)Names and versions of the multiple apps ({vendor}.{appname}@{x.x.x}) to uninstall.

Options

OptionAliasDescription
--yes-yAnswers yes to all prompts.

Examples

  vtex uninstall
  vtex uninstall vtex.service-example
  vtex uninstall [email protected]
🔼 Back

unlink

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

Usage

  $ vtex unlink [APPID] [ITHAPPID]

appname Name of the app to unlink.

Arguments

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

Options

OptionAliasDescription
--all-aUnlinks all apps.

Examples

  vtex unlink
  vtex unlink [email protected]
🔼 Back

update

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

Usage

  $ vtex update

Example

  vtex update
🔼 Back

whoami

ℹ

️ This command refers to the plugin @vtex/cli-plugin-whoami. Follow this link this link to learn more about VTEX IO's CLI plugins.

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

Usage

  $ vtex whoami

Example

  vtex whoami
🔼 Back

workspace abtest finish

ℹ

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

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

Usage

  $ vtex workspace abtest finish
🔼 Back

workspace abtest start

ℹ

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

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

Usage

  $ vtex workspace abtest start
🔼 Back

workspace abtest status

ℹ

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

Displays the results of the active A/B tests.

Usage

  $ vtex workspace abtest status
🔼 Back

workspace delete

Deletes one or many workspaces from the current account.

Usage

  $ vtex workspace delete WORKSPACE1 [ITHWORKSPACE]

Arguments

ArgumentDescription
WORKSPACE1Name of the workspace to delete.
ITHWORKSPACE (optional)Name of the multiple workspaces to delete.

Options

OptionAliasDescription
--force-fDeletes the specified workspace even if it is currently in use.
--yes-yAnswers yes to all prompts.

Examples

  vtex workspace delete workspaceName
  vtex workspace delete workspaceName1 workspaceName2
🔼 Back

workspace list

Lists all workspaces of the current account.

Usage

  $ vtex workspace list

Aliases

  $ vtex workspace ls

Examples

  vtex workspace list
  vtex workspace ls
🔼 Back

workspace promote

Promotes the current workspace to master. Only works for production workspaces.

Usage

  $ vtex workspace promote

Aliases

  $ vtex promote

Examples

  vtex workspace promote
  vtex promote
🔼 Back

workspace reset

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

Usage

  $ vtex workspace reset [WORKSPACENAME]

Arguments

ArgumentDescription
WORKSPACENAME (optional)Name of the workspace to reset.

Options

OptionAliasDescription
--production-pRecreates the workspace as a production one.
--yes-yAnswers yes to all prompts.

Examples

  vtex workspace reset
  vtex workspace reset workspaceName
🔼 Back

workspace status

Displays information about the specified workspace.

Usage

  $ vtex workspace status [WORKSPACENAME]

Arguments

ArgumentDescription
WORKSPACENAME (optional)Name of the workspace.

Example

  vtex workspace status
🔼 Back

workspace use

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

Usage

  $ vtex workspace use WORKSPACE

Arguments

ArgumentDescription
WORKSPACEName of the workspace to use.

Options

OptionAliasDescription
--production-pCreates and/or switches to a production workspace.
--reset-rResets the workspace before switching to it.

Aliases

  $ vtex use

Examples

  vtex workspace use workspaceName
  vtex use workspaceName
🔼 Back

Plugins

Check in the following a brief description of the commands available by VTEX plugins. For a detailed description of each command, click on 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.

ℹ

️ Follow this link this link to learn more about VTEX IO's CLI plugins.

Plugin commandFunctionality
addAdds the specified app(s) to the manifest's dependencies.
config getPrints the value of the requested configuration key.
config resetResets the specified configuration to its default value.
config setSets the value of a configuration key.
debug dotnetDebugs .NET applications (IDEs only).
infra installInstalls an infra service.
infra listLists installed infra services.
infra updateUpdates all installed infra services.
lighthouse auditRuns a Lighthouse audit over the specified URL.
lighthouse showShows a previous audit report, filtering by app and/or URL.
logsShows logs of an app (only apps in production).
plugins installInstalls a plugin into the CLI.
plugins linkLinks a plugin into the CLI for development.
plugins:listLists all plugins installed on your machine.
plugins sourceLists all plugins supported by VTEX.
plugins uninstallRemoves a plugin from the CLI.
plugins:updateUpdates all plugins installed on your machine.
redirects deleteDeletes redirects from the current account and workspace.
redirects exportExports all redirects defined in the current account and workspace to a CSV file.
redirects importImports redirects from a CSV file to the current account and workspace.
settings getPrints the settings of the specified app.
settings setSets value to the specified setting of an app.
settings unsetDisables the specified setting of an app.
submitSubmits the current app, or an specified one, to validation from VTEX App Store team.
supportLogs in as support to another VTEX account.
test e2eRuns E2E integration tests for the app in the current directory.
test unitRuns unit tests for the app in the current directory.
urlPrints base URL for the current account and workspace.
🔼 Back

add

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

Usage

$ vtex add APPID [ITHAPPID]

Arguments

ArgumentDescription
APPIDName and version ({vendor}.{appname}@{x.x.x}) of the dependency to include in the manifest.json file.
ITHAPPID (optional)Names and versions ({vendor}.{appname}@{x.x.x}) of the multiple dependencies to include in the manifest.json file.

Example

vtex add [email protected]
🔼 Back

autoupdate

Automatically updates VTEX IO's CLI.

Usage

  $ vtex autoupdate [CHANNEL]

Arguments

ArgumentDescription
CHANNEL (optional).
🔼 Back

config get

Prints the value of the requested configuration key.

Usage

$ vtex config get CONFIGNAME

Arguments

ArgumentDescription
CONFIGNAMEConfiguration to retrieve the value from.

Example

 vtex config get env
 vtex config get cluster
🔼 Back

config reset

Resets the specified configuration to its default value.

Usage

$ vtex config reset CONFIGNAME

Arguments

ArgumentDescription
CONFIGNAMEName of the configuration to reset.

Example

 vtex config reset env
 vtex config reset cluster
🔼 Back

config set

Sets the value of a configuration key.

Usage

$ vtex config set CONFIGNAME VALUE

Arguments

ArgumentDescription
CONFIGNAMEName of the configuration.
VALUENew value of the specified configuration.

Example

  vtex config set env envValue
  vtex config set cluster clusterValue
🔼 Back

debug donet

Debugs .NET applications (IDEs only).

Usage

  $ vtex debug dotnet DEBUGINST

Arguments

ArgumentDescription
DEBUGINSTName of the .NET application to debug.
🔼 Back

infra install

Installs an infra service.

Usage

  $ vtex infra install SERVICEID

Arguments

ArgumentDescription
SERVICEIDName and version of the service ({vendor}.{servicename}@{x.x.x}) to install.

Examples

  vtex infra install infra-service
  vtex infra install [email protected]
🔼 Back

infra list

Lists installed infra services.

Usage

  $ vtex infra list [NAME]

Arguments

ArgumentDescription
NAME (optional)Service name.

Options

OptionAliasDescription
--available-aLists services that are available to install.
--filter=filter-fLists services that contain the specified word.

Aliases

  $ vtex infra ls

Examples

  vtex infra list
  vtex infra ls
🔼 Back

infra update

Updates all installed infra services.

Usage

  $ vtex infra update

Example

  vtex infra update
🔼 Back

lighthouse audit

Runs a Lighthouse audit over the specified URL.

Usage

  $ vtex lighthouse audit URL

Arguments

ArgumentDescription
URLURL to audit.

Options

OptionAliasDescription
--json-jReturns the report as a json on stdout.

Aliases

  $ vtex lh audit

Examples

  vtex lighthouse audit my.url.com
  vtex lh audit my.url.com
🔼 Back

lighthouse show

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

Usage

  $ vtex lighthouse show

Options

OptionAliasDescription
--app=app-aFilters by app name.
--url=url-uFilters by URL.

Aliases

  $ vtex lh show

Examples

  vtex lighthouse show --app=vtex.awesome-app
  vtex lighthouse show -u https://awesome.store.com
  vtex lighthouse show -a vtex.awesome-app --url=https://awesome.store.com
  vtex lh show --app=vtex.awesome-app
  vtex lh show -u https://awesome.store.com
  vtex lh show -a vtex.awesome-app --url=https://awesome.store.com
🔼 Back

logs

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

Usage

  $ vtex logs [APP]

Arguments

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

Options

OptionAliasDescription
--all-aShows logs of every app installed on the current account.
--past-pShows previous logs of the specified app.

Examples

  vtex logs
  vtex logs appName
  vtex logs --all
  vtex logs appName --past
🔼 Back

plugins install

Installs a plugin into the CLI.

Usage

  $ vtex plugins install PLUGIN

Arguments

ArgumentDescription
PLUGINPlugin to install.

Options

OptionAliasDescription
--force-fRefetches all packages, even the ones that were previously installed.

Aliases

  $ vtex plugins:add

Examples

  vtex plugins install lighthouse
  vtex plugins install https://github.com/vtex/cli-plugin-someplugin
  vtex plugins install @vtex/cli-plugin-someplugin
🔼 Back

plugins link

Links a plugin into the CLI for development.

Usage

  $ vtex plugins link PLUGIN

Arguments

ArgumentDescription
PATH [default: .]Plugin path.

Examples

   vtex plugins link myplugin
🔼 Back

plugins list

Lists all plugins installed on your machine.

Usage

  $ vtex plugins:list

Options

OptionDescription
--coreShows core plugins.

Examples

  vtex plugins list
🔼 Back

plugins source

Lists all plugins supported by VTEX.

Usage

  $ vtex plugins source PLUGIN

Arguments

ArgumentDescription
PLUGINPlugin name.
PATH [default: .]Plugin path.

Examples

  vtex plugins source myplugin
🔼 Back

plugins uninstall

Removes a plugin from the CLI.

Usage

  $ vtex plugins uninstall PLUGIN

Arguments

ArgumentDescription
PLUGINPlugin to uninstall.

Aliases

  $ vtex plugins unlink
  $ vtex plugins remove

Examples

vtex plugins uninstall lighthouse
vtex plugins remove lighthouse
vtex plugins unlink lighthouse
🔼 Back

plugins update

Updates all plugins installed on your machine.

Usage

  $ vtex plugins update

redirects delete

Deletes redirects from the current account and workspace.

Usage

  $ vtex redirects delete CSVPATH

Arguments

ArgumentDescription
CSVPATHCSV file containing the URL paths to be deleted.

Example

  vtex redirects delete csvPath
🔼 Back

redirects export

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

Usage

  $ vtex redirects export CSVPATH

Arguments

ArgumentDescription
CSVPATHName of the CSV file.

Example

  vtex redirects export csvPath
🔼 Back

redirects import

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

Usage

  $ vtex redirects import CSVPATH

Options

OptionAliasDescription
--reset-rRemoves all redirects previously defined.

Example

  vtex redirects import csvPath
🔼 Back

settings get

Prints the settings of the specified app.

Usage

  $ vtex settings get APPNAME [FIELD]

Arguments

ArgumentDescription
APNAMEName of the app to check the available settings.
FIELD (optional)Name of the setting.

Aliases

  $ vtex settings

Example

  vtex settings get vtex.service-example
🔼 Back

settings set

Sets value to the specified setting of an app.

Usage

  $ vtex settings set APPNAME FIELD VALUE 

Arguments

ArgumentDescription
APPNAMEName of the app.
FIELDName of the setting.
VALUEValue of the setting.

Example

  vtex settings set vtex.store enableCriticalCSS true
🔼 Back

settings unset

Disables the specified setting of an app.

Usage

  $ vtex settings unset APPNAME FIELD

Arguments

ArgumentDescription
APPNAMEName of the app.
FIELDName of the setting.

Example

  vtex settings unset vtex.service-example fieldName
🔼 Back

submit

Submits the current app, or an specified one, to validation from VTEX App Store team.

Usage

  $ vtex submit [APPID]

Arguments

ArgumentDescription
APPID (optional)Name of the app to be validated.

Examples

  vtex submit
  vtex submit [email protected]
🔼 Back

support

Logs in as support to another VTEX account.

Usage

  $ vtex support ACCOUNT

Arguments

ArgumentDescription
ACCOUNTName of the account to give support.

Example

  vtex support storecomponents
🔼 Back

test e2e

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

Usage

  $ vtex test e2e

Options

OptionAliasDescription
--report=report-rDisplays 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. It can be dangerous since it exposes your token via the 'authToken' environment variable.
--workspace-wRuns tests for the apps installed on the specified workspace.
🔼 Back

test unit

Runs unit tests for the app in the current directory.

Usage

  $ vtex test unit

Options

OptionAliasDescription
--unsafe-uIgnores Typescript errors
🔼 Back

url

Prints base URL for current account, workspace and environment.

Usage

  $ vtex url

Example

  vtex url
🔼 Back

Updated 3 days ago


Command reference


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.