✨ 🤖 🐶 the new CLI for apollo
This is the home of Rover, the new CLI for Apollo's suite of GraphQL developer productivity tools.
This README contains just enough info to get you started with Rover. Our docs contain more detailed information that should be your primary reference for all things Rover.
A few useful Rover commands to interact with your graphs:
- Fetch a graph from a federated remote endpoint.
rover graph fetch test@cats- Validate recent changes made to your local graph with
rover graph check.
rover graph check --schema=./path-to-valid-sdl test@cats- Publish your local graph to Apollo Studio.
rover graph publish --schema ./path-to-valid-schema test@cats$ rover help
Rover - Your Graph Companion
Usage: rover [OPTIONS] <COMMAND>
Commands:
config
Configuration profile commands
contract
Contract configuration commands
dev
Combine multiple subgraphs into a local supergraph
supergraph
Supergraph schema commands
graph
Graph API schema commands
template
Commands for working with templates
readme
Readme commands
subgraph
Subgraph schema commands
docs
Interact with Rover's documentation
update
Commands related to updating rover
persisted-queries
Preview feature: Commands for persisted queries [aliases: pq]
explain
Explain error codes
help
Print this message or the help of the given subcommand(s)
Options:
-l, --log <LOG_LEVEL>
Specify Rover's log level
--format <FORMAT_KIND>
Specify Rover's format type [possible values: plain, json]
-o, --output <OUTPUT_FILE>
Specify a file to write Rover's output to
--insecure-accept-invalid-certs
Accept invalid certificates when performing HTTPS requests
--insecure-accept-invalid-hostnames
Accept invalid hostnames when performing HTTPS requests
--client-timeout <CLIENT_TIMEOUT>
Configure the timeout length (in seconds) when performing HTTP(S) requests [default: 30]
--skip-update-check
Skip checking for newer versions of rover
-h, --help
Print help (see more with '--help')
-V, --version
Print version
Read the getting started guide by running:
$ rover docs open start
To begin working with Rover and to authenticate with Apollo Studio,
run the following command:
$ rover config auth
This will prompt you for an API Key that can be generated in Apollo Studio.
The most common commands from there are:
- rover graph fetch: Fetch a graph schema from the Apollo graph registry
- rover graph check: Check for breaking changes in a local graph schema against a graph schema in the Apollo graph
registry
- rover graph publish: Publish an updated graph schema to the Apollo graph registry
You can open the full documentation for Rover by running:
$ rover docs openThis repo is organized as a cargo workspace, containing several related projects:
rover: Apollo's suite of GraphQL developer productivity toolshouston: utilities for configuring Roverrobot-panic: a fork ofrust-cli/human-panicadjusted for Roverrover-client: an HTTP client for making GraphQL requests for Roversputnik: a crate to aid in collection of anonymous data for Rust CLIstimber: Rover's logging formatter
To install the latest release of Rover:
curl -sSL https://rover.apollo.dev/nix/latest | shTo 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.10.0 | shYou will need curl installed on your system to run the above installation commands. You can get the latest version from the curl downloads page.
Note:
rover supergraph composeis currently not available for Alpine Linux. You may track the progress for supporting this command on Alpine in this issue.
iwr 'https://rover.apollo.dev/win/latest' | iexTo 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.10.0' | iexRover is distributed on npm for easy integration with your JavaScript projects.
If you'd like to install rover as a devDependency in your JavaScript project, you can run npm i --save-dev @apollo/rover. You can then call rover directly in your package.json scripts, or you can run npx rover in your project directory to execute commands.
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.
You can also download the binary for your operating system and manually add its location to your PATH.
If you don't see your CPU architecture supported as part of our release pipeline, you can build from source with cargo. Clone this repo, and run cargo xtask dist --version v0.1.3. This will compile a released version of Rover for you, and place the binary in your target directory.
git clone https://github.com/apollographql/rover
cargo xtask dist --version v0.1.3
From here you can either place the binary in your PATH manually, or run ./target/release/{optional_target}/rover install.
See this page for info about contributing to Rover.
Source code in this repository is covered by (i) an MIT compatible license or (ii) the Elastic License 2.0, in each case, as designated by a licensing file within a subdirectory or file header. The default throughout the repository is an MIT compatible license, unless a file header or a licensing file in a subdirectory specifies another license.