Setting the file. One moment.
Subchapter 13.1
references/additional-commands.mdMarkdown5 KBView on GitHub
Reference for Rover commands that support project scaffolding, API key management, plugin installation, and other utility tasks.
Scaffold a new project from an official Apollo template.
List available templates:
rover template listGenerate a project from a template:
rover template use my-project --template subgraph-javascriptThe command creates a new directory with the template’s files. Run rover template list to see available template IDs.
Manage the README displayed for a graph variant in Apollo Studio.
rover readme fetch my-graph@productionPrints the variant’s README content to stdout.
rover readme publish my-graph@production --file ./README.mdPublishes the contents of the specified file as the variant’s README in Studio.
Create, list, rotate, rename, and delete API keys for a GraphOS organization. Requires authentication with a credential that has the appropriate organization permissions.
# 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.
rover api-key list <ORG_ID>Lists all API keys (operator, subgraph, and client-credential pairs) for the organization.
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.
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.
rover api-key delete <ORG_ID> <KEY_ID>Deletes an API key or client-credential pair. This action cannot be undone.
Manage officially supported plugins that Rover downloads and runs: router, supergraph, and apollo-mcp-server.
# 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 acceptPlugins 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 |
Fetch an offline enterprise license for self-hosted Apollo Router deployments.
rover license fetch my-graph@productionPrints the offline license JWT to stdout. Redirect to a file for use with the Router:
rover license fetch my-graph@production > license.jwtOffline license support must be enabled on your Studio organization. Contact your Apollo representative if you receive error E044.
Manage graph artifacts (persisted query manifests and other build outputs) stored in GraphOS.
rover graph-artifact fetch my-graph@production --artifact-id <ID># 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>rover graph-artifact tag my-graph@production --digest <DIGEST> --tag "stable"rover graph-artifact untag my-graph@production --tag "stable"Generate shell completion scripts for tab-completing Rover commands and options.
# Add to ~/.bashrc
eval "$(rover completion bash)"
# Or write to a file
rover completion bash > ~/.rover/completions.bash
source ~/.rover/completions.bash# Add to ~/.zshrc
eval "$(rover completion zsh)"
# Or write to a completions directory
rover completion zsh > ~/.zfunc/_roverLook up a Rover error code to see its description, common causes, and suggested fixes.
rover explain E001
rover explain E029Use this when Rover prints an error code (e.g., error[E029]) to understand why the error occurred and how to resolve it.
Access Rover’s documentation from the command line.
rover docs listPrints all available documentation topic shortlinks.
# Open a specific topic in your browser
rover docs open start
rover docs open configuring
rover docs open migrationThe topic argument matches the shortlinks shown by rover docs list.