Rover README commands
Publish and retrieve your graph variant's README
These Rover commands enable you to publish and fetch the
READMEs are
Fetching a README from GraphOS
readme fetch
readme fetch
This command requires
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
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 existsrover readme fetch my-graph@my-variant --output README.md
You can also request the output as JSON with the --format json
option:
rover readme fetch my-graph@my-variant --format json
For more on passing values via stdout
, see
Publishing a README to GraphOS
readme publish
readme publish
This command requires
You can use Rover to publish a README to one of your
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
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