VTEX Developer Portal

Installing the VTEX IO CLI

According to your operating system, take the respective steps to install VTEX IO’s CLI on your machine.

 MacOS
  • Brew

    ️ Warning

    For machines running on Apple M1 chip, before installing VTEX IO CLI, install Rosetta and enable the machine 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 Homebrew by following the instructions on Homebrew website.

    brewbrew

    1. Then, install VTEX IO'S CLI by running the following command.
    brew tap vtex/vtex
    brew install vtex
    

 Linux
  • Tarball

    ️ Caution

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

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

    curl -L https://vtex.io/vtexcli/install | sh
    

 Windows
  • 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 finish the installation process.

Installing the CLI via NPM

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

️Danger

We strongly recommend using an alternative installation method. If you opt to use npm to install the VTEX IO CLI, keep in mind that the CLI won't be automatically updated, and the Node version on your machine might conflict with the one used by the CLI developers. Preferably, if you opt for any other installation method, VTEX IO's CLI will always be up-to-date, and you will avoid installation issues.

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

brewbrew

  1. Install Node.js via Homebrew by running the following command.
brew install node
  1. Then, install Yarn.
brew install yarn
  1. Finally, install the VTEX IO CLI.
yarn global add vtex

 Linux
  1. Install Node.js by running the following command.
sudo apt install nodejs
  1. Install Yarn by following the Yarn installation for Linux.
  2. Install the VTEX IO CLI by running the following command.
sudo yarn global add vtex

 Windows
  1. Download and install Node.js.
  2. Download and install Yarn.
  3. Open the terminal.
  4. Install the VTEX IO CLI by running the following command.
yarn global add vtex

Verifying the installation

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

vtex

vtexvtex

Troubleshooting

If VTEX IO's CLI is not behaving as expected, run vtex --version to make sure you're using the latest version available. If not, consider updating it.

If the problem persists, check the following instructions.

Error: Cannot find module 'vtex'

This error is related to plugins detached from the VTEX IO's CLI base code.

Even though plugins are decoupled from VTEX IO's CLI, they rely on the CLI functionalities. Therefore, this error signalizes that these plugins are failing to access VTEX IO's CLI functionalities.

To solve this problem, you will need to create a symlink from {vtex-folder}/node_modules/vtex to {vtex-folder}/.

According to your operating system, run the following command in the terminal to create a symlink:

  •   MacOS

    ln -s /usr/local/Cellar/vtex/2.119.2/libexec /usr/local/Cellar/vtex/2.119.2/libexec/node_modules/vtex
    
  •  Linux

    ln -s /usr/local/lib/vtex /usr/local/lib/vtex/node_modules/vtex
    

If the error persists, don't hesitate to open a support ticket.

Updated 3 days ago


Installing the VTEX IO CLI


Suggested Edits are limited on API Reference Pages

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