According to your operating system, follow the respective steps to install VTEX IO CLI on your computer.

• Brew

For computers running on an Apple M series chip (M1, M2, etc.), before installing VTEX IO CLI, install Rosetta. This enables your computer to use the command-line interface for a Mac with an Intel processor. To install Rosetta, run the following in your terminal: /usr/sbin/softwareupdate --install-rosetta --agree-to-license.

1. Install Xcode by running the following command:

2. Install Homebrew by following the instructions on the Homebrew website.

1. Install VTEX IO CLI by running the following command:

• Tarball

  Before the installation, check if you have the curl command-line tool and library installed on your computer.

  Open the terminal and run the following command to install VTEX IO CLI.

• Installer for Windows

  1. Download the appropriate installer for your Windows system (64-bit installer; 32-bit installer).
  2. Open the downloaded file and follow the instructions to complete the installation process.
  3. Run the Windows Terminal with admin permission by right-clicking the Windows Terminal icon and selecting Run as administrator.
  4. Run the following command to complete the installation:

After completing these steps, you'll see the following message:

Further usage of VTEX IO CLI doesn't require admin permission.

Since VTEX IO CLI is built with Node.js, you can install it manually via npm. This method is recommended only for environments where auto-updating VTEX IO CLI is not ideal.

We highly recommend using an alternative installation method. If you choose to install VTEX IO CLI via npm, remember that CLI won't update automatically, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, preventing installation issues.

 MacOS

1. Install Homebrew by following the instructions on the Homebrew website.

2. Install Node.js via Homebrew by running the following command.

_10

brew install node

3. Then, install Yarn.

_10

brew install yarn

4. Finally, install VTEX IO CLI.

_10

yarn global add vtex

 Linux

1. Install Node.js by running the following command:

_10

sudo apt install nodejs

2. Install Yarn by following the Yarn installation for Linux.
3. Install VTEX IO CLI by running the following command:

_10

sudo yarn global add vtex

 Windows

1. Download and install Node.js.
2. Download and install Yarn.
3. Run the Windows Terminal with elevated administrator permission by right-clicking the Windows Terminal icon and selecting Run as administrator.
4. Install VTEX IO CLI by running the following command.

_10

yarn global add vtex

5. Run the following command to finish the installation.

_10

vtex

After following the steps, this message will appear.

You don't have to be in your admin role for the next step.

To confirm that the installation went as expected, run the following command to check all default commands available in VTEX IO CLI.

If you are having problems after installing VTEX IO, see the I can't install VTEX IO CLI troubleshooting guide.