Command reference
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 Name | Functionality |
|---|---|
autoupdate | Automatically updates VTEX IO's 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 in 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 | Sets the Edition App version for the current account. |
help | Displays help for VTEX CLI commands. |
init | Copies starting files and folders from VTEX boilerplates into your local directories. |
install | Installs an app on the current workspace. If not specified which one, it defaults to the app in the current directory. |
link | Syncs the app in the current directory with the development workspace in use. |
list | Lists the apps installed on the current workspace and account. |
local token | Prints the user's auth token and copies it to the clipboard. |
login | Logs in to a VTEX account. |
logout | Logs out of the current VTEX account. |
publish | Publishes 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. |
setup | Sets up typings and tools for the current development environment. |
switch | Switches to another VTEX account. |
undeprecate | Reestablishes a deprecated version of an app as 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 the current account, workspace, environment, and login details. |
workspace abtest finish | Stops all A/B tests from running 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 works 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. |
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
| Argument | Description |
|---|---|
| CHANNEL (optional) | . |
browse
Opens the URL relative to your current workspace and account in a new browser window.
Usage
$ vtex browse [PATH]
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
vtex browse
vtex browse admin
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
| Argument | Description |
|---|---|
| APPID (optional) | 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
vtex deploy
vtex deploy [email protected]
deprecate
Deprecates the specified app, uninstalling and downgrading it to the latest stable version in every VTEX account.
Usage
$ vtex deprecate [APPID] [ITHAPPID]
Arguments
| Argument | Description |
|---|---|
| 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
| Option | Alias | Description |
|---|---|---|
| --yes | -y | Answers yes to all prompts. |
Examples
vtex deprecate
vtex deprecate [email protected]
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
| Argument | Description |
|---|---|
| WORKSPACE1 (optional) | First workspace for comparison. |
| WORKSPACE2 (optional) | [default: master] Second workspace for comparison. |
Example
vtex deps diff workspace1 workspace2
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
| Option | Alias | Description |
|---|---|---|
| --keys | -k | Shows only key dependencies. |
| --npm | -n | Includes dependencies from the npm registry. |
Alias
$ vtex deps ls
Examples
vtex deps list
vtex deps ls
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
| Argument | Description |
|---|---|
| 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]
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
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
| Argument | Description |
|---|---|
| EDITION | Name of the Edition App to install. |
Example
vtex edition set editionName
help
Displays help for VTEX CLI commands.
Usage
$ vtex help [COMMAND]
Arguments
| Argument | Description |
|---|---|
| COMMAND (optional) | Command to show help about. |
Options
| Option | Alias | Description |
|---|---|---|
| --all | - | Displays all commands available in the CLI. |
init
Copies starting files and folders from VTEX boilerplates into your local directories.
Usage
$ vtex init
Example
vtex init
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
| Argument | Description |
|---|---|
| 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
| Option | Alias | Description |
|---|---|---|
| --force | -f | Installs the specified app without checking for route conflicts. |
Examples
vtex install
vtex install [email protected]
vtex install [email protected]
link
Syncs the app in the current directory with the development workspace in use.
Usage
$ vtex link
Options
| Option | Alias | Description |
|---|---|---|
| --account=account | -a | Starts a development session in the specified account. Must be paired with the '--workspace' flag. |
| --clean | -c | Cleans 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. 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
list
Lists the apps installed on the current workspace and account.
Usage
$ vtex list
Aliases
$ vtex ls
Examples
vtex list
vtex ls
local token
Prints the user's auth token and copies it to the clipboard.
Usage
$ vtex local token
Example
vtex local token
login
Logs in to a VTEX account.
Usage
$ vtex login [ACCOUNT]
Arguments
| Argument | Description |
|---|---|
| ACCOUNT (optional) | Account name to log in. |
Options
| Option | Alias | Description |
|---|---|---|
| --workspace=workspace | -w | Logs in the specified workspace. |
Examples
vtex login
vtex login storecomponents
logout
Logs out of the current VTEX account.
Usage
$ vtex logout
Example
vtex logout
publish
Publishes the app in the current directory as a release candidate version.
Usage
$ vtex publish
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
vtex publish
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
| Argument | Description |
|---|---|
| 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
setup
Sets up typings and tools for the current development environment.
Usage
$ vtex setup
Options
| Option | Alias | Description |
|---|---|---|
| --ignore-linked | -i | Sets 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. |
switch
Switches to another VTEX account.
Usage
$ vtex switch ACCOUNT
Arguments
| Argument | Description |
|---|---|
| ACCOUNT | Account name to log in. |
Options
| Option | Alias | Description |
|---|---|---|
| --workspace=workspace | -w | Moves to the specified workspace. |
Examples
vtex switch storecomponents
undeprecate
Reestablishes a deprecated version of an app as a stable version.
Usage
$ vtex undeprecate [APPID] [ITHAPPID]
Arguments
| Argument | Description |
|---|---|
| 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
| Option | Alias | Description |
|---|---|---|
| --yes | -y | Answers yes to all prompts. |
Example
vtex undeprecate [email protected]
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
| Argument | Description |
|---|---|
| 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
| Option | Alias | Description |
|---|---|---|
| --yes | -y | Answers yes to all prompts. |
Examples
vtex uninstall
vtex uninstall vtex.service-example
vtex uninstall [email protected]
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
| Argument | Description |
|---|---|
| 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
| Option | Alias | Description |
|---|---|---|
| --all | -a | Unlinks all apps. |
Examples
vtex unlink
vtex unlink [email protected]
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
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
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
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
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
workspace delete
Deletes one or many workspaces from the current account.
Usage
$ vtex workspace delete WORKSPACE1 [ITHWORKSPACE]
Arguments
| Argument | Description |
|---|---|
| WORKSPACE1 | Name of the workspace to delete. |
| ITHWORKSPACE (optional) | Name of the multiple workspaces to delete. |
Options
| Option | Alias | Description |
|---|---|---|
| --force | -f | Deletes the specified workspace even if it is currently in use. |
| --yes | -y | Answers yes to all prompts. |
Examples
vtex workspace delete workspaceName
vtex workspace delete workspaceName1 workspaceName2
workspace list
Lists all workspaces of the current account.
Usage
$ vtex workspace list
Aliases
$ vtex workspace ls
Examples
vtex workspace list
vtex workspace ls
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
workspace reset
Cleans all configurations of the specified workspace and recreates it with the configurations from master.
Usage
$ vtex workspace reset [WORKSPACENAME]
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
vtex workspace reset
vtex workspace reset workspaceName
workspace status
Displays information about the specified workspace.
Usage
$ vtex workspace status [WORKSPACENAME]
Arguments
| Argument | Description |
|---|---|
| WORKSPACENAME (optional) | Name of the workspace. |
Example
vtex workspace status
workspace use
Creates and switches to a new workspace or simply switches to an existing one.
Usage
$ vtex workspace use WORKSPACE
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
$ vtex use
Examples
vtex workspace use workspaceName
vtex use workspaceName
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 command | Functionality |
|---|---|
add | Adds the specified app(s) to the manifest's 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, filtering by app and/or URL. |
logs | Shows logs of an app (only apps in production). |
plugins install | Installs a plugin into the CLI. |
plugins link | Links a plugin into the 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 the 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 an specified one, to validation from 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 base URL for the current account and workspace. |
add
Adds the specified app(s) to the manifest's dependencies.
Usage
$ vtex add APPID [ITHAPPID]
Arguments
| Argument | Description |
|---|---|
| APPID | Name 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]
autoupdate
Automatically updates VTEX IO's CLI.
Usage
$ vtex autoupdate [CHANNEL]
Arguments
| Argument | Description |
|---|---|
| CHANNEL (optional) | . |
config get
Prints the value of the requested configuration key.
Usage
$ vtex config get CONFIGNAME
Arguments
| Argument | Description |
|---|---|
| CONFIGNAME | Configuration to retrieve the value from. |
Example
vtex config get env
vtex config get cluster
config reset
Resets the specified configuration to its default value.
Usage
$ vtex config reset CONFIGNAME
Arguments
| Argument | Description |
|---|---|
| CONFIGNAME | Name of the configuration to reset. |
Example
vtex config reset env
vtex config reset cluster
config set
Sets the value of a configuration key.
Usage
$ vtex config set CONFIGNAME VALUE
Arguments
| Argument | Description |
|---|---|
| CONFIGNAME | Name of the configuration. |
| VALUE | New value of the specified configuration. |
Example
vtex config set env envValue
vtex config set cluster clusterValue
debug donet
Debugs .NET applications (IDEs only).
Usage
$ vtex debug dotnet DEBUGINST
Arguments
| Argument | Description |
|---|---|
| DEBUGINST | Name of the .NET application to debug. |
infra install
Installs an infra service.
Usage
$ vtex infra install SERVICEID
Arguments
| Argument | Description |
|---|---|
| SERVICEID | Name and version of the service ({vendor}.{servicename}@{x.x.x}) to install. |
Examples
vtex infra install infra-service
vtex infra install [email protected]
infra list
Lists installed infra services.
Usage
$ vtex infra list [NAME]
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
$ vtex infra ls
Examples
vtex infra list
vtex infra ls
infra update
Updates all installed infra services.
Usage
$ vtex infra update
Example
vtex infra update
lighthouse audit
Runs a Lighthouse audit over the specified URL.
Usage
$ vtex lighthouse audit URL
Arguments
| Argument | Description |
|---|---|
| URL | URL to audit. |
Options
| Option | Alias | Description |
|---|---|---|
| --json | -j | Returns the report as a json on stdout. |
Aliases
$ vtex lh audit
Examples
vtex lighthouse audit my.url.com
vtex lh audit my.url.com
lighthouse show
Shows a previous audit report, filtering by app and/or URL.
Usage
$ vtex lighthouse show
Options
| Option | Alias | Description |
|---|---|---|
| --app=app | -a | Filters by app name. |
| --url=url | -u | Filters 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
logs
Shows logs of an app. (Only apps in production.)
Usage
$ vtex logs [APP]
Arguments
| Argument | Description |
|---|---|
| APP (optional) | Name of the app to show logs. |
Options
| Option | Alias | Description |
|---|---|---|
| --all | -a | Shows logs of every app installed on the current account. |
| --past | -p | Shows previous logs of the specified app. |
Examples
vtex logs
vtex logs appName
vtex logs --all
vtex logs appName --past
plugins install
Installs a plugin into the CLI.
Usage
$ vtex plugins install PLUGIN
Arguments
| Argument | Description |
|---|---|
| PLUGIN | Plugin to install. |
Options
| Option | Alias | Description |
|---|---|---|
| --force | -f | Refetches 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
plugins link
Links a plugin into the CLI for development.
Usage
$ vtex plugins link PLUGIN
Arguments
| Argument | Description |
|---|---|
| PATH [default: .] | Plugin path. |
Examples
vtex plugins link myplugin
plugins list
Lists all plugins installed on your machine.
Usage
$ vtex plugins:list
Options
| Option | Description |
|---|---|
| --core | Shows core plugins. |
Examples
vtex plugins list
plugins source
Lists all plugins supported by VTEX.
Usage
$ vtex plugins source PLUGIN
Arguments
| Argument | Description |
|---|---|
| PLUGIN | Plugin name. |
| PATH [default: .] | Plugin path. |
Examples
vtex plugins source myplugin
plugins uninstall
Removes a plugin from the CLI.
Usage
$ vtex plugins uninstall PLUGIN
Arguments
| Argument | Description |
|---|---|
| PLUGIN | Plugin to uninstall. |
Aliases
$ vtex plugins unlink
$ vtex plugins remove
Examples
vtex plugins uninstall lighthouse
vtex plugins remove lighthouse
vtex plugins unlink lighthouse
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
| Argument | Description |
|---|---|
| CSVPATH | CSV file containing the URL paths to be deleted. |
Example
vtex redirects delete csvPath
redirects export
Exports all redirects defined in the current account and workspace to a CSV file.
Usage
$ vtex redirects export CSVPATH
Arguments
| Argument | Description |
|---|---|
| CSVPATH | Name of the CSV file. |
Example
vtex redirects export csvPath
redirects import
Imports redirects from a CSV file to the current account and workspace.
Usage
$ vtex redirects import CSVPATH
Options
| Option | Alias | Description |
|---|---|---|
| --reset | -r | Removes all redirects previously defined. |
Example
vtex redirects import csvPath
settings get
Prints the settings of the specified app.
Usage
$ vtex settings get APPNAME [FIELD]
Arguments
| Argument | Description |
|---|---|
| APNAME | Name of the app to check the available settings. |
| FIELD (optional) | Name of the setting. |
Aliases
$ vtex settings
Example
vtex settings get vtex.service-example
settings set
Sets value to the specified setting of an app.
Usage
$ vtex settings set APPNAME FIELD VALUE
Arguments
| Argument | Description |
|---|---|
| APPNAME | Name of the app. |
| FIELD | Name of the setting. |
| VALUE | Value of the setting. |
Example
vtex settings set vtex.store enableCriticalCSS true
settings unset
Disables the specified setting of an app.
Usage
$ vtex settings unset APPNAME FIELD
Arguments
| Argument | Description |
|---|---|
| APPNAME | Name of the app. |
| FIELD | Name of the setting. |
Example
vtex settings unset vtex.service-example fieldName
submit
Submits the current app, or an specified one, to validation from VTEX App Store team.
Usage
$ vtex submit [APPID]
Arguments
| Argument | Description |
|---|---|
| APPID (optional) | Name of the app to be validated. |
Examples
vtex submit
vtex submit [email protected]
support
Logs in as support to another VTEX account.
Usage
$ vtex support ACCOUNT
Arguments
| Argument | Description |
|---|---|
| ACCOUNT | Name of the account to give support. |
Example
vtex support storecomponents
test e2e
Runs E2E integration tests for the app in the current directory.
Usage
$ vtex test e2e
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. It can be dangerous since it exposes your token via the 'authToken' environment variable. |
| --workspace | -w | Runs tests for the apps installed on the specified workspace. |
test unit
Runs unit tests for the app in the current directory.
Usage
$ vtex test unit
Options
| Option | Alias | Description |
|---|---|---|
| --unsafe | -u | Ignores Typescript errors |
url
Prints base URL for current account, workspace and environment.
Usage
$ vtex url
Example
vtex url
Updated about 1 month ago