Installing Rover
The Rover CLI is available for Linux, Mac, and Windows.
Installation Methods
Linux and MacOS curl | sh
installer
To install the latest release of Rover:
curl -sSL https://rover.apollo.dev/nix/latest | sh
To install a specific version of Rover (note the v
prefixing the version number):
Note: If you're installing Rover in a CI environment, it's best to target a specific version rather than using the latest URL, since future major breaking changes could affect CI workflows otherwise.
curl -sSL https://rover.apollo.dev/nix/v0.0.9 | sh
Windows PowerShell installer
iwr 'https://rover.apollo.dev/win/latest' | iex
To install a specific version of Rover (note the v
prefixing the version number):
Note: If you're installing Rover in a CI environment, it's best to target a specific version rather than using the latest URL, since future major breaking changes could affect CI workflows otherwise.
iwr 'https://rover.apollo.dev/win/v0.0.9' | iex
npm installer
Rover is distributed on npm for easy integration with your JavaScript projects.
devDependencies
install
If you'd like to install rover
within the devDependencies
of your JavaScript project, you can run npm i --save-dev @apollo/rover
. You can then call rover <parameters>
directly in your package.json
scripts, or you can run npx -p @apollo/rover rover <parameters>
in your project directory to execute commands.
Note: When using
npx
, the-p @apollo/rover
argument is necessary to specify that the@apollo/rover
package provides therover
command. Seenpx
's documentation for more information.
Manual download and install
If you'd like to call rover
from any directory on your machine, you can run npm i -g @apollo/rover
.
Note: Unfortunately if you've installed npm
without a version manager such as nvm
, you may have trouble with global installs. If you encounter an EACCES
permission-related error while trying to install globally, DO NOT run the install command with sudo
. This support page has information that should help to resolve this issue.
Without curl
You can also download the binary for your operating system and manually add its location to your PATH
.
Connecting to Studio
After you install Rover, you should authenticate it with Apollo Studio, because many of its commands communicate with Studio.
Run the following command:
rover config auth
This command instructs you where to obtain a personal API key and helps you set up a configuration profile. For more information, see Configuring Rover.