title	description
Rover README commands	Publish and retrieve your graph variant's README

These Rover commands are for publishing and fetching the README associated with a graph variant.

READMEs are Markdown based, and support Apollo-specific shortcodes, which are documented here.

Fetching a README from Apollo Studio

This requires first authenticating Rover with Apollo Studio.

You can use Rover to fetch the README of any Studio graph variant.

Run the readme fetch command, like so:

rover readme fetch my-graph@my-variant

The argument my-graph@my-variant is the graph ref, which you can read about here.

By default, the README will be output to stdout. You can also save the output to a .md file like so:

# Creates README.md or overwrites if it already exists
rover readme fetch my-graph@my-variant > README.md

To request the output as JSON, use the --output json option:

rover readme fetch my-graph@my-variant --output json

For more on passing values via stdout, see Conventions.

Publishing a README to Apollo Studio

This requires first authenticating Rover with Apollo Studio.

You can use Rover to publish a README to one of your Apollo Studio graphs.

Use the readme publish command, like so:

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

The argument my-graph@my-variant is the graph ref, which you can read about here.

You can also pipe the contents of the README in via stdin by providing - as the value of the --file option, like so:

echo "sample readme contents" | rover readme publish my-graph@my-variant --file -

For more on accepting input via stdin, see Conventions.