Skip to content

Latest commit

 

History

History
119 lines (80 loc) · 4.07 KB

README.md

File metadata and controls

119 lines (80 loc) · 4.07 KB

Rover

✨ 🤖 🐶 the new CLI for apollo

Tests Stability: Experimental Netlify Status

This is the home of Rover, the new CLI for Apollo's suite of GraphQL developer productivity tools.

Usage

A few useful Rover comamnds to interact with your graphs.

  1. Validate recent changes made to your local graph with rover graph check.
rover graph check --schema=./path-to-valid-sdl test@cats
  1. Push your local graph to Apollo Studio.
rover graph push --schema ./path-to-valid-schema test@cats
  1. Fetch a graph from a federated remote endpoint.
rover subgraph fetch --name=pets test@cats

Command-line options

$ rover --help
Rover 0.0.1-rc.6

Rover - Your Graph Companion
Read the getting started guide: https://go.apollo.dev/r/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 push: Push an updated graph schema to the Apollo graph registry

You can find full documentation for Rover here: https://go.apollo.dev/r/docs

USAGE:
    rover [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -l, --log <log-level>     [default: debug]  [possible values: error, warn, info,
                             debug, trace]

SUBCOMMANDS:
    config      Configuration profile commands
    graph       Non-federated schema/graph commands
    help        Prints this message or the help of the given subcommand(s)
    subgraph    Federated schema/graph commands

This repo is organized as a cargo workspace, containing several related projects:

  • rover: Apollo's suite of GraphQL developer productivity tools
  • houston: utilities for configuring Rover
  • robot-panic: a fork of rust-cli/robot-panic adjusted for Rover
  • rover-client: an HTTP client for making GraphQL requests for Rover
  • sputnik: a crate to aid in collection of anonymous data for Rust CLIs
  • timber: a log formatter for env_logger and log crates

Installation

You can install Rover by running

Linux and MacOS

curl -sSL https://raw.githubusercontent.com/apollographql/rover/v0.0.1-rc.6/installers/binstall/scripts/nix/install.sh | VERSION=v0.0.1-rc.6 sh

Windows

iwr 'https://raw.githubusercontent.com/apollographql/rover/v0.0.1-rc.6/installers/binstall/scripts/windows/install.ps1' | iex

Alternatively, you can download the binary for your operating system and manually adding its location to your PATH.

Contributions

This project is in very early development. As a result, we are not currently accepting external contributions.

License

This project is licensed under the MIT License (LICENSE or http://opensource.org/licenses/MIT).