Index of every page on this site: llms.txt
All skills
apollographql avatar

/rover

@9dda139 official
by Apollo GraphQLapollographql/skills134 stars
14
Run it yourself

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), (7) initializing a new graph project or MCP server with rover init, (8) working with Apollo Connectors, contracts, persisted queries, or client operations, (9) managing API keys, plugins, templates, or graph artifacts.

Use this Skill: https://skilld.dev/gh/apollographql/skills/rover

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencesadditional-commands.md

≈1.4k tokens on demand. Your agent reads this file only when SKILL.md points to it.

Additional Rover Commands

Reference for Rover commands that support project scaffolding, API key management, plugin installation, and other utility tasks.

rover template

Scaffold a new project from an official Apollo template.

template list

List available templates:

rover template list

template use

Generate a project from a template:

rover template use my-project --template subgraph-javascript

The command creates a new directory with the template's files. Run rover template list to see available template IDs.

rover readme

Manage the README displayed for a graph variant in Apollo Studio.

readme fetch

rover readme fetch my-graph@production

Prints the variant's README content to stdout.

readme publish

rover readme publish my-graph@production --file ./README.md

Publishes the contents of the specified file as the variant's README in Studio.

rover api-key

Create, list, rotate, rename, and delete API keys for a GraphOS organization. Requires authentication with a credential that has the appropriate organization permissions.

api-key create

# Create an operator key
rover api-key create <ORG_ID> operator "CI deploy key"

# Create a subgraph key
rover api-key create <ORG_ID> subgraph "products-subgraph-key"

# Create a client-credential pair (OAuth 2.0 client-credentials grant)
rover api-key create <ORG_ID> client-credentials "my-service"

Creating a key prints the secret once. Save it immediately. Rover does not display it again.

api-key list

rover api-key list <ORG_ID>

Lists all API keys (operator, subgraph, and client-credential pairs) for the organization.

api-key rename

rover api-key rename <ORG_ID> <KEY_ID> "new-name"

Renames an operator or subgraph API key. Client-credential pairs cannot be renamed. To change a pair's name, create a new one and delete the old one.

api-key rotate

rover api-key rotate <ORG_ID> <CLIENT_ID>

Rotates the secret for a client-credential pair. Only client-credential pairs support rotation. Operator and subgraph keys do not have a rotate equivalent.

api-key delete

rover api-key delete <ORG_ID> <KEY_ID>

Deletes an API key or client-credential pair. This action cannot be undone.

rover plugin

Manage officially supported plugins that Rover downloads and runs: router, supergraph, and apollo-mcp-server.

plugin install

# Install a specific version
rover plugin install router@=1.57.1

# Install a specific supergraph composition plugin
rover plugin install supergraph@=2.9.3

# Force reinstall (overwrites existing)
rover plugin install router@=1.57.1 --force

# Accept the ELv2 license non-interactively
rover plugin install router@=1.57.1 --elv2-license accept

Plugins are installed to ~/.rover/bin/ by default. Commands like rover dev and rover supergraph compose install plugins automatically when needed. Use rover plugin install to pre-install in CI or air-gapped environments.

Version formats:

Format Meaning
=1.57.1 Exact version
1 Latest 1.x release
latest-2 Latest 2.x release

rover license

Fetch an offline enterprise license for self-hosted Apollo Router deployments.

license fetch

rover license fetch my-graph@production

Prints the offline license JWT to stdout. Redirect to a file for use with the Router:

rover license fetch my-graph@production > license.jwt

Offline license support must be enabled on your Studio organization. Contact your Apollo representative if you receive error E044.

rover graph-artifact

Manage graph artifacts (persisted query manifests and other build outputs) stored in GraphOS.

graph-artifact fetch

rover graph-artifact fetch my-graph@production --artifact-id <ID>

graph-artifact list-tags

# List tags for a graph
rover graph-artifact list-tags my-graph@production

# List tags for a specific artifact by digest
rover graph-artifact list-tags my-graph@production --digest <DIGEST>

graph-artifact tag

rover graph-artifact tag my-graph@production --digest <DIGEST> --tag "stable"

graph-artifact untag

rover graph-artifact untag my-graph@production --tag "stable"

rover completion

Generate shell completion scripts for tab-completing Rover commands and options.

bash

# Add to ~/.bashrc
eval "$(rover completion bash)"

# Or write to a file
rover completion bash > ~/.rover/completions.bash
source ~/.rover/completions.bash

zsh

# Add to ~/.zshrc
eval "$(rover completion zsh)"

# Or write to a completions directory
rover completion zsh > ~/.zfunc/_rover

rover explain

Look up a Rover error code to see its description, common causes, and suggested fixes.

rover explain E001
rover explain E029

Use this when Rover prints an error code (e.g., error[E029]) to understand why the error occurred and how to resolve it.

rover docs

Access Rover's documentation from the command line.

docs list

rover docs list

Prints all available documentation topic shortlinks.

docs open

# Open a specific topic in your browser
rover docs open start
rover docs open configuring
rover docs open migration

The topic argument matches the shortlinks shown by rover docs list.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning24d5 checks · Risk SAFE
  • Gen Agent Trust Hub24d

    This skill provides a comprehensive guide for managing GraphQL schemas using the Apollo Rover CLI. While it includes commands for remote installation and schema ingestion, these are standard operations targeting official Apollo GraphQL infrastructure and follow security best practices.

  • Socket24d

    No alerts

  • Snyk24d

    Risk: LOW · No issues

  • Runlayer9mo

    6/6 files flagged

  • ZeroLeaks7mo

    1 finding · Score: 82/100

Signed by skilld at 9dda139. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 weeks ago.

Activeupdated 4 weeks ago
What it can do
Runs commands
compatibility
Node.js v18+, Linux/macOS/Windows
metadata
{
  "author": "apollographql",
  "version": "1.2.0"
}
All 1 allowed tools
Bash(rover:*) Bash(npm:*) Bash(npx:*) Read Write Edit Glob Grep
  • CLI
  • graphql
  • apollo
  • rover
  • federation
  • schema
  • supergraph
  • graphos
  • subgraph

README badge

README badge for apollographql/skills/rover

Manages GraphQL schemas and federation via the Apollo Rover CLI, including publishing subgraphs, composing supergraphs, and validating schemas with check and lint commands. Designed for local schema exploration via piped commands (rover schema describe/search) and GraphOS integration workflows, with built-in support for federated and monograph architectures.

Generated from the current SKILL.md.

Does Rover work with both federated and non-federated GraphQL graphs?
Yes. Use `rover subgraph` commands for federated graphs and `rover graph` commands for monographs (non-federated graphs). Both workflows are supported.
How do I explore a large GraphQL schema without loading the entire SDL into context?
Pipe `rover graph fetch` into `rover schema describe` or `rover schema search` — these commands read the schema via stdin and return only a compact overview or search results, keeping context manageable.
What's the difference between `rover graph fetch` and `rover supergraph fetch`?
`rover graph fetch` returns the API schema (what you can query), while `rover supergraph fetch` returns the composed supergraph SDL with federation internals like `join__` and `link__`. Use the former for schema exploration and the latter for composition/router work.
Can Rover execute GraphQL queries, or does it only manage schemas?
Rover only manages and inspects schemas. To run a generated query, you must send it to the graph's endpoint separately using curl or another HTTP client.
Does this skill require a GraphOS account, or can I use Rover offline?
Most Rover commands (publish, fetch, check) require authentication with a GraphOS API key. Local composition with `rover supergraph compose` and schema exploration of local files work offline.

Generated from the current SKILL.md. These answers refresh after source changes.