VTEX IO - Getting Started

Introduction to VTEX IO

Last updated

VTEX IO is VTEX's web application development platform.

In this track, we will teach you step by step how to develop an app using VTEX IO.

Basic Structure

See in the image below the hierarchical structure of VTEX IO:

VTEX IO Hierarchy

  • Account: To develop an app, you need to have a VTEX account.
  • Workspaces: These are the environments where the apps will be developed. These environments are linked to the account. You may have multiple workspaces for a single account.
  • App: it's the application itself. Apps are developed within workspaces. Multiple apps can be developed within a single workspace.


To get started, fist install the VTEX CLI using the package manager of your choice:

npm i -g vtex


yarn global add vtex

You can run vtex -v to check if it was successfully installed.


You can run vtex login or vtex login -a {accountName} to login to your VTEX account.

If you still don't have an account, please head to http://www.vtex.com/partner/

Still got questions?
Ask the community
Find solutions and share ideas in VTEX's community.
Talk to our experts
Get in touch if you have something specific to ask about the platform.
  • PT
  • ES
VTEX website