Back to Skills

rover

Guide for using Apollo Rover CLI to manage GraphQL schemas and federation. Use this skill when: (1) publishing or fetching subgraph/graph schemas, (2) composing supergraph schemas locally or via GraphOS, (3) running local supergraph development with rover dev, (4) validating schemas with check and lint commands, (5) configuring Rover authentication and environment, (6) exploring or searching a graph's schema for agent-driven discovery (rover schema describe / rover schema search).

104stars12forksUpdated 8/13/2026

Security Assessment

Safe(92/100)
Security Score92/100

About rover

This skill is a usage guide for the Apollo Rover CLI, the official command-line tool for Apollo GraphOS. It addresses the everyday friction of managing GraphQL schemas and federation: publishing and fetching subgraph or monograph schemas, composing supergraphs locally or via GraphOS, running local supergraph development, and validating schema changes with check and lint commands before they reach production. It also emphasizes an agent-friendly schema-exploration pattern that keeps large SDL out of the agent's context.

Capabilities documented include installation across macOS/Linux/Windows (official install scripts and npm), interactive and API-key authentication, environment/profile configuration, and the core command set: subgraph publish/check/fetch/introspect, supergraph compose, rover dev, and graph publish. A notable feature is the schema exploration workflow for agents: fetch the API schema with `rover graph fetch` and pipe it into `rover schema describe` or `rover schema search` to answer 'what is in this graph?' or find a field without flooding context. Configuration coverage extends to APOLLO_KEY/APOLLO_GRAPH_REF variables, CI/CD examples for GitHub Actions and CircleCI, telemetry opt-out, proxy, and TLS settings.

Target users are GraphQL platform engineers, backend developers working in federated architectures, and CI/CD authors who publish and validate schemas, as well as AI agents performing schema discovery. Typical use cases are publishing a subgraph from a file or introspection, checking schema changes against production traffic in a PR gate, composing and running a supergraph locally, and exploring an existing graph's schema.

FAQ

How do I install and authenticate Rover?

Install via the official curl/PowerShell scripts or `npm install -g @apollo/rover`, then authenticate interactively with `rover config auth` or by setting the APOLLO_KEY environment variable (recommended for CI/CD).

What is the recommended way to explore a graph's schema?

Fetch the API schema with `rover graph fetch <graph@variant>` and pipe it into `rover schema describe -` or `rover schema search - "<keyword>"`. This keeps large SDL out of context; the schema commands read piped SDL, not a graph reference.

What are the compatibility requirements?

The skill declares Node.js v18+ and Linux/macOS/Windows compatibility, and it is MIT-licensed.

How are credentials handled?

API keys are supplied via the APOLLO_KEY environment variable or stored by `rover config auth` in ~/.rover/config.toml. The guide favors environment variables for CI and never hardcodes keys in code.

Can it be used in CI/CD pipelines?

Yes. It includes GitHub Actions and CircleCI examples using APOLLO_KEY and APOLLO_GRAPH_REF for subgraph checks and publishes as PR gates and deploy steps.

All Files

7 files
references/configuration.md5.6 KB
View
references/subgraphs.md5.9 KB
View
references/schema.md9.0 KB
View
SKILL.md11.8 KB
View
references/dev.md5.6 KB
View
references/graphs.md4.5 KB
View
references/supergraphs.md5.6 KB
View

Install rover

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill