VTEX IO CLI installation and command reference

Any development in VTEX IO begins and ends with the Toolbelt, our CLI (Command Line Interface).

Toolbelt allows you to login to a desired VTEX account, link your local files to the platform, manage an account's workspaces, in addition to performing any action necessary to your development process.

Installation

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

Thereafter, type yarn global add vtex in your computer’s terminal.

$ yarn global add vtex

Troubleshooting

After installing and running vtex in the terminal, an error saying that the command or program wasn't found may show up.

This happens due to an error concerning the Yarn installation. The yarn global add command does not properly add Yarn binaries to a directory known by your terminal as PATH.

By not adding the Yarn binaries to terminal PATH, Yarn and its programs can't be found, thereby resulting in an error when running Toolbelt.

Workaround for MacOS and Linux users

1. In your local directories, find the Profile file. It is usually hidden and is named after the command line's interpreter. For example: If you're using bash, your Profile file will be named bashrc. If you use zsh, it will be zshrc;
2. Once in the Profile file, add the following command: export PATH="$PATH: yarn global bin";
3. Log in and log out of your terminal for the changes to take effect;

Workaround for Windows users

1. Runs the yarn global bin command in your terminal. It will return the path in which the yarn global binaries were saved;
2. Copy it to your clipboard. This path now must be added to the Windows Environment Variable Path;
3. Click on the windows button and search for environment. Then, click on Edit the system environment variables;
4. In the System Properties dialog, click on the Environment Variables... button;
5. In User Variables, select Path and then click on the Edit... button;
6. Click on the New button to add a new path to the search;
7. Paste the yarn global binary path copied in step 2 and click OK when prompted. This will save your changes;
8. Log in and log out of your terminal for the changes to take effect.

If the error persists, don't hesitate to send a ticket to our support team.

Command Reference

Every command executed in Toolbelt must begin with vtex, irrespective of its name, as can be seen in the examples in the command table below.