Documentation
Feedback
Guides
App Development

App Development
VTEX IO CLI
Installing VTEX IO CLI

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

MacOS

  • Brew

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

    {"base64":"  ","img":{"width":832,"height":152,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":27210,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-install-0.png"}}

    1. Then, install VTEX IO CLI by running the following command.

    _10
    brew tap vtex/vtex
    _10
    brew install vtex

Linux

  • 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.


    _10
    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.
  3. Run the Windows Terminal with elevated administrator permission by right-clicking the Windows Terminal icon and selecting "Run as administrator."
  4. Run the following command to finish the installation.

_10
vtex

After following the steps, this message will appear.

{"base64":"  ","img":{"width":812,"height":121,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":18614,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-install-1.png"}}

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

Installing CLI via NPM

Since VTEX IO CLI is built with Node.js, you can manually install it 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 opt to use npm to install the VTEX IO CLI, remember that CLI won't be automatically updated, 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, and you will avoid installation issues.

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

{"base64":"  ","img":{"width":832,"height":152,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":27210,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-install-2.png"}}

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

_10
brew install node

  1. Then, install Yarn.

_10
brew install yarn

  1. 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

  1. Install Yarn by following the Yarn installation for Linux.
  2. 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

  1. Run the following command to finish the installation.

_10
vtex

After following the steps, this message will appear.

{"base64":"  ","img":{"width":812,"height":121,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":18614,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-install-3.png"}}

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


Verifying the installation

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


_10
vtex

{"base64":"  ","img":{"width":2206,"height":1302,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":307862,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-vtex-io-cli-install-4.png"}}

Troubleshooting

If VTEX IO 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, please check the following instructions.

Error: Cannot find 'vtex' module

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

Even though plugins are decoupled from VTEX IO CLI, they rely on the CLI features. Therefore, this error indicates that these plugins are failing to access VTEX IO CLI features.

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


    _10
    ln -s /usr/local/Cellar/vtex/2.119.2/libexec /usr/local/Cellar/vtex/2.119.2/libexec/node_modules/vtex

  •  Linux


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

If the error persists, open a support ticket.


Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
1
Photo of the contributor
+ 1 contributors
On this page