VTEX Developer Portal

Basic setup to develop in VTEX IO

Any development in VTEX IO begins and ends with the VTEX IO CLI. The VTEX IO CLI works as a communication gateway between your VTEX account and the VTEX IO development platform.

With VTEX IO's CLI, you will be able to log in to your VTEX account, manage workspaces, develop apps, and install new ones.

Installing VTEX IO's CLI

To install VTEX IO’s CLI, you need to ensure that Node.js and Yarn are properly installed on your machine.

To follow all the required steps for installing VTEX IO's CLI, access our documentation on VTEX IO CLI Installation and Command Reference.

Logging in to your VTEX account

Once VTEX IO’s CLI is installed, log in to your VTEX account with the following command:

$ vtex login {accountName}

This will open a browser window asking for your credentials.

️ Replace {accountName} with the name of your VTEX account.

Once you are logged in, run the vtex whoami command to show which VTEX account and workspace are being used by the VTEX IO CLI.

VTEX IO CLI - whoamiVTEX IO CLI - whoami

Creating your own workspace

When using VTEX IO, any development must happen in a workspace.

A workspace works as a GitHub branch in the sense that any development operation is done in a specific workspace that is separate from others. This means that workspaces allow you to develop and test your changes without any risk of interfering with live apps or with the work of other developers.

To start developing, you have to create a Developer workspace in your VTEX account. When you log in, you are automatically using the Master workspace, which means you are in the version available to the end user.

Run the vtex use command in your terminal as shown below:

$ vtex use {exampleName}

This changes your VTEX account to a Development workspace called exampleName, creating it from scratch if it does not already exist.

workspace-examplename ENworkspace-examplename EN

Having logged in to your account and created your own Development workspace, you are ready to begin developing your React app and building your storefront using VTEX IO.

Updated 4 days ago



Basic setup to develop in VTEX IO


Suggested Edits are limited on API Reference Pages

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