Installation
Last updated
Last updated
The CLI is available as and requires to run. If you have Node.js installed you can install the CLI using a JavaScript package manager. For instance, you can use , which comes with Node.js, or alternative package managers like .
We recommend installing the CLI globally. Installing the CLI globally makes sure it can be used in all your projects. For that reason all examples in this documentation will assume a global installation.
For more advanced uses, the CLI can be installed in your project as a development dependency.
When installed globally, trying running the following command in your Terminal to verify whether it's installed correctly.
this should give you the following response:
In case your are using bash, you can add export PATH="$PATH:$(yarn global bin)"
to your ~/.bash_profile
and reload it with source ~/.bash_profile
When installed as a development dependency, run the following command to verify the CLI is working correctly:
Enable auto-complete for shell commands with:
This command updates either your ~/.zshrc
or ~/.bashrc
file, depending on your shell. Reload your shell using:
or
Now, you can use the tab key to complete commands and view command arguments by typing and pressing tab.