Docs
Try Apollo Studio

Rover README commands

Publish and retrieve your graph variant's README


These Rover commands enable you to publish and fetch the README associated with a particular graph variant.

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

Fetching a README from Apollo Studio

readme fetch

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

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.

Output format

By default, the README is 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

You can also request the output as JSON with 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

readme publish

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 in the README's contents 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.

Edit on GitHub
Previous
template
Next
subgraph