Documentation
Feedback
Guides
App Development

App Development
VTEX IO CLI
Command reference

This documentation is a reference for:

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.

Default commands

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 nameDescription
autoupdateAutomatically updates VTEX IO 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 on 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 setDisplays the version of the Edition App for the current account.
helpDisplays help for VTEX CLI commands.
initCopies starting files and folders from VTEX boilerplates to your local directories.
installInstalls an app on the current workspace. If no app is specified, it defaults to the app in the current directory.
linkSyncs the app in the current directory with the development workspace being used.
listLists the apps installed on the current workspace and account.
local tokenPrints the user auth token and copies it to the clipboard.
loginLogs into a VTEX account.
logoutLogs out from the current VTEX account.
publishPublishes 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.
setupSets up typing and tools for the current development environment.
switchSwitches to another VTEX account.
undeprecateReverts a deprecated version of an app to 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 details about the current account, workspace, environment, and login information.
workspace abtest finishStops all A/B tests 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 applicable 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 @vtex/cli-plugin-autoupdate plugin. Access this link to learn more about VTEX IO CLI plugins.

Automatically updates VTEX IO CLI.

Usage


_10
vtex autoupdate [CHANNEL]

Arguments

ArgumentDescription
CHANNEL (optional)Channel for which to display the logs.
๐Ÿ”ผ Back

browse

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

Usage


_10
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


_10
vtex browse
_10
vtex browse admin

๐Ÿ”ผ Back

deploy

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


_10
vtex deploy [APPID]

Arguments

ArgumentDescription
APPID (optional)The 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


_10
vtex deploy
_10
vtex deploy vtex.service-example@0.0.1

๐Ÿ”ผ Back

deprecate

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

Usage


_10
vtex deprecate [APPID] [ITHAPPID]

Arguments

ArgumentDescription
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

OptionAliasDescription
--yes-yAnswers yes to all prompts.

Examples


_10
vtex deprecate
_10
vtex deprecate vtex.service-example@0.0.1

๐Ÿ”ผ Back

deps diff

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


_10
vtex deps diff [WORKSPACE1] [WORKSPACE2]

Arguments

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

Example


_10
vtex deps diff workspace1 workspace2

๐Ÿ”ผ Back

deps list

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


_10
vtex deps list

Options

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

Alias


_10
vtex deps ls

Examples


_10
vtex deps list
_10
vtex deps ls

๐Ÿ”ผ Back

deps update

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


_10
vtex deps update [APPID] [ITHAPPID]

Arguments

ArgumentDescription
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


_10
vtex deps update
_10
vtex deps update vtex.service-example@0.0.1

๐Ÿ”ผ Back

edition get

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


_10
vtex edition get

Example


_10
vtex edition get

๐Ÿ”ผ Back

edition set

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


_10
vtex edition set EDITION

Arguments

ArgumentDescription
EDITIONName of the Edition App to install.

Example


_10
vtex edition set editionName

๐Ÿ”ผ Back

help

Displays help for VTEX CLI commands.

Usage


_10
vtex help [COMMAND]

Arguments

ArgumentDescription
COMMAND (optional)Command to show help.

Options

OptionAliasDescription
--all-Displays all commands available in CLI.
๐Ÿ”ผ Back

init

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

Usage


_10
vtex init

Example


_10
vtex init

๐Ÿ”ผ Back

install

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

Usage


_10
vtex install [APPID] [ITHAPPID]

Arguments

ArgumentDescription
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

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

Examples


_10
vtex install
_10
vtex install vtex.service-example@0.x
_10
vtex install vtex.service-example@0.0.1

๐Ÿ”ผ Back

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

Usage


_10
vtex link

Options

OptionAliasDescription
--account=account-aStarts a development session in the specified account. Must be used together with the '--workspace' flag.
--clean-cCleans the 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. 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


_10
vtex link -a youraccount -w yourworkspace

๐Ÿ”ผ Back

list

Lists the apps installed on the current workspace and account.

Usage


_10
vtex list

Aliases


_10
vtex ls

Examples


_10
vtex list
_10
vtex ls

๐Ÿ”ผ Back

local token

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

Usage


_10
vtex local token

Example


_10
vtex local token

๐Ÿ”ผ Back

login

Logs into a VTEX account.

Usage


_10
vtex login [ACCOUNT]

Arguments

ArgumentDescription
ACCOUNT (optional)Account name to log in.

Options

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

Examples


_10
vtex login
_10
vtex login storecomponents

๐Ÿ”ผ Back

logout

Logs out from the current VTEX account.

Usage


_10
vtex logout

Example


_10
vtex logout

๐Ÿ”ผ Back

publish

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

Usage


_10
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


_10
vtex publish

๐Ÿ”ผ Back

release

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

Usage


_10
vtex release [RELEASETYPE] [TAGNAME]

Arguments

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

Examples


_10
vtex release
_10
vtex release patch
_10
vtex release patch beta
_10
vtex release minor stable
_10
vtex release pre

๐Ÿ”ผ Back

setup

Configures typings and tools for the current development environment.

Usage


_10
vtex setup

Options

OptionAliasDescription
--ignore-linked-iConfigures 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.
๐Ÿ”ผ Back

switch

Switches to another VTEX account.

Usage


_10
vtex switch ACCOUNT

Arguments

ArgumentDescription
ACCOUNTThe name of the account to log in to.

Options

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

Examples


_10
vtex switch storecomponents

๐Ÿ”ผ Back

undeprecate

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

Usage


_10
vtex undeprecate [APPID] [ITHAPPID]

Arguments

ArgumentDescription
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

OptionAliasDescription
--yes-yAnswers yes to all prompts.

Example


_10
vtex undeprecate vtex.service-example@0.0.1

๐Ÿ”ผ Back

uninstall

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

Usage


_10
vtex uninstall [APPNAME] [ITHAPPNAME]

Arguments

ArgumentDescription
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

OptionAliasDescription
--yes-yAnswers yes to all prompts.

Examples


_10
vtex uninstall
_10
vtex uninstall vtex.service-example
_10
vtex uninstall vtex.service-example@0.x

๐Ÿ”ผ Back

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

Usage


_10
vtex unlink [APPID] [ITHAPPID]

appname Name of the app to unlink.

Arguments

ArgumentDescription
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

OptionAliasDescription
--all-aUnlinks all apps.

Examples


_10
vtex unlink
_10
vtex unlink vtex.service-example@0.x

๐Ÿ”ผ Back

update

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

Usage


_10
vtex update

Example


_10
vtex update

๐Ÿ”ผ Back

whoami

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


_10
vtex whoami

Example


_10
vtex whoami

๐Ÿ”ผ Back

workspace abtest finish

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


_10
vtex workspace abtest finish

๐Ÿ”ผ Back

workspace abtest start

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


_10
vtex workspace abtest start

๐Ÿ”ผ Back

workspace abtest status

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


_10
vtex workspace abtest status

๐Ÿ”ผ Back

workspace delete

Deletes one or many workspaces from the current account.

Usage


_10
vtex workspace delete WORKSPACE1 [ITHWORKSPACE]

Arguments

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

Options

OptionAliasDescription
--force-fDeletes the specified workspace, even if it is currently being used.
--yes-yAnswers yes to all prompts.

Examples


_10
vtex workspace delete workspaceName
_10
vtex workspace delete workspaceName1 workspaceName2

๐Ÿ”ผ Back

workspace list

Lists all workspaces of the current account.

Usage


_10
vtex workspace list

Aliases


_10
vtex workspace ls

Examples


_10
vtex workspace list
_10
vtex workspace ls

๐Ÿ”ผ Back

workspace promote

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

Usage


_10
vtex workspace promote

Aliases


_10
vtex promote

Examples


_10
vtex workspace promote
_10
vtex promote

๐Ÿ”ผ Back

workspace reset

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

Usage


_10
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


_10
vtex workspace reset
_10
vtex workspace reset workspaceName

๐Ÿ”ผ Back

workspace status

Displays information about the specified workspace.

Usage


_10
vtex workspace status [WORKSPACENAME]

Arguments

ArgumentDescription
WORKSPACENAME (optional)Name of the workspace.

Example


_10
vtex workspace status

๐Ÿ”ผ Back

workspace use

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

Usage


_10
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


_10
vtex use

Examples


_10
vtex workspace use workspaceName
_10
vtex use workspaceName

๐Ÿ”ผ Back

Plugins

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 commandDescription
addAdds the specified app(s) to the manifest 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, filtered by app and/or URL.
logsShows logs of an app (only apps in production).
plugins installInstalls a plugin on CLI.
plugins linkLinks a plugin to CLI for development.
plugins:listLists all plugins installed on your machine.
plugins sourceLists all plugins supported by VTEX.
plugins uninstallRemoves a plugin from 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 a specified one, for validation by the 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 the base URL for the current account and workspace.
๐Ÿ”ผ Back

add

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

Usage


_10
vtex add APPID [ITHAPPID]

Arguments

ArgumentDescription
APPIDThe 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


_10
vtex add vtex.service-example@0.x

๐Ÿ”ผ Back

autoupdate

Automatically updates VTEX IO CLI.

Usage


_10
vtex autoupdate [CHANNEL]

Arguments

ArgumentDescription
CHANNEL (optional).
๐Ÿ”ผ Back

config get

Prints the value of the requested configuration key.

Usage


_10
vtex config get CONFIGNAME

Arguments

ArgumentDescription
CONFIGNAMEConfiguration to retrieve the value from.

Example


_10
vtex config get env
_10
vtex config get cluster

๐Ÿ”ผ Back

config reset

Resets the specified configuration to its default value.

Usage


_10
vtex config reset CONFIGNAME

Arguments

ArgumentDescription
CONFIGNAMEName of the configuration to reset.

Example


_10
vtex config reset env
_10
vtex config reset cluster

๐Ÿ”ผ Back

config set

Sets the value of a configuration key.

Usage


_10
vtex config set CONFIGNAME VALUE

Arguments

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

Example


_10
vtex config set env envValue
_10
vtex config set cluster clusterValue

๐Ÿ”ผ Back

debug donet

Debugs .NET applications (IDEs only).

Usage


_10
vtex debug dotnet DEBUGINST

Arguments

ArgumentDescription
DEBUGINSTName of the .NET application to debug.
๐Ÿ”ผ Back

infra install

Installs an infra service.

Usage


_10
vtex infra install SERVICEID

Arguments

ArgumentDescription
SERVICEIDThe name and version of the service to install, specified in the format {vendor}.{servicename}@{x.x.x}.

Examples


_10
vtex infra install infra-service
_10
vtex infra install infra-service@0.0.1

๐Ÿ”ผ Back

infra list

Lists installed infra services.

Usage


_10
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


_10
vtex infra ls

Examples


_10
vtex infra list
_10
vtex infra ls

๐Ÿ”ผ Back

infra update

Updates all installed infra services.

Usage


_10
vtex infra update

Example


_10
vtex infra update

๐Ÿ”ผ Back

lighthouse audit

Runs a Lighthouse audit over the specified URL.

Usage


_10
vtex lighthouse audit URL

Arguments

ArgumentDescription
URLURL to audit.

Options

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

Aliases


_10
vtex lh audit

Examples


_10
vtex lighthouse audit my.url.com
_10
vtex lh audit my.url.com

๐Ÿ”ผ Back

lighthouse show

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

Usage


_10
vtex lighthouse show

Options

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

Aliases


_10
vtex lh show

Examples


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

๐Ÿ”ผ Back

logs

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

Usage


_10
vtex logs [APP]

Arguments

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

Options

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

Examples


_10
vtex logs
_10
vtex logs appName
_10
vtex logs --all
_10
vtex logs appName --past

๐Ÿ”ผ Back

plugins install

Installs a plugin on the CLI.

Usage


_10
vtex plugins install PLUGIN

Arguments

ArgumentDescription
PLUGINPlugin to install.

Options

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

Aliases


_10
vtex plugins:add

Examples


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

๐Ÿ”ผ Back

Links a plugin to CLI for development.

Usage


_10
vtex plugins link PLUGIN

Arguments

ArgumentDescription
PATH [default: .]Plugin path.

Examples


_10
vtex plugins link myplugin

๐Ÿ”ผ Back

plugins list

Lists all plugins installed on your machine.

Usage


_10
vtex plugins:list

Options

OptionDescription
--coreShows core plugins.

Examples


_10
vtex plugins list

๐Ÿ”ผ Back

plugins source

Lists all plugins supported by VTEX.

Usage


_10
vtex plugins source PLUGIN

Arguments

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

Examples


_10
vtex plugins source myplugin

๐Ÿ”ผ Back

plugins uninstall

Removes a plugin from CLI.

Usage


_10
vtex plugins uninstall PLUGIN

Arguments

ArgumentDescription
PLUGINPlugin to uninstall.

Aliases


_10
vtex plugins unlink
_10
vtex plugins remove

Examples


_10
vtex plugins uninstall lighthouse
_10
vtex plugins remove lighthouse
_10
vtex plugins unlink lighthouse

๐Ÿ”ผ Back

plugins update

Updates all plugins installed on your machine.

Usage


_10
vtex plugins update

redirects delete

Deletes redirects from the current account and workspace.

Usage


_10
vtex redirects delete CSVPATH

Arguments

ArgumentDescription
CSVPATHCSV file containing the URL paths to delete.

Example


_10
vtex redirects delete csvPath

๐Ÿ”ผ Back

redirects export

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

Usage


_10
vtex redirects export CSVPATH

Arguments

ArgumentDescription
CSVPATHName of the CSV file.

Example


_10
vtex redirects export csvPath

๐Ÿ”ผ Back

redirects import

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

Usage


_10
vtex redirects import CSVPATH

Options

OptionAliasDescription
--reset-rRemoves all previously defined redirects.

Example


_10
vtex redirects import csvPath

๐Ÿ”ผ Back

settings get

Prints the settings of the specified app.

Usage


_10
vtex settings get APPNAME [FIELD]

Arguments

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

Aliases


_10
vtex settings

Example


_10
vtex settings get vtex.service-example

๐Ÿ”ผ Back

settings set

Sets the value for the specified setting of an app.

Usage


_10
vtex settings set APPNAME FIELD VALUE

Arguments

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

Example


_10
vtex settings set vtex.store enableCriticalCSS true

๐Ÿ”ผ Back

settings unset

Disables the specified setting of an app.

Usage


_10
vtex settings unset APPNAME FIELD

Arguments

ArgumentDescription
APPNAMEName of the app.
FIELDName of the setting.

Example


_10
vtex settings unset vtex.service-example fieldName

๐Ÿ”ผ Back

submit

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

Usage


_10
vtex submit [APPID]

Arguments

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

Examples


_10
vtex submit
_10
vtex submit myvendor.myapp@1.2.3

๐Ÿ”ผ Back

support

Logs in as support to another VTEX account.

Usage


_10
vtex support ACCOUNT

Arguments

ArgumentDescription
ACCOUNTName of the account to give support.

Example


_10
vtex support storecomponents

๐Ÿ”ผ Back

test e2e

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

Usage


_10
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. Please note that this action can be potentially dangerous as it exposes your token through 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


_10
vtex test unit

Options

OptionAliasDescription
--unsafe-uIgnores TypeScript errors
๐Ÿ”ผ Back

url

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

Usage


_10
vtex url

Example


_10
vtex url

๐Ÿ”ผ Back
Contributors
4
Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 4 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
4
Photo of the contributor
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 4 contributors
On this page