Rover 说明文件命令

这些Rover 命令使您能够发布和检索与特定 README 相关的 图形 变体.

README 是 基于 Markdown 的，并支持 Apollo 专用的短代码，相关文档 在此处。

从 GraphOS 获取 README

readme fetch

您可以使用 Rover 获取您可访问的任何 Studio graph 变体的说明文件。

运行 readme fetch 命令，如下所示：

1
rover readme fetch my-graph@my-variant

参数my-graph@my-variant是graph ref，您可以在这里了解有关此内容。

输出格式

默认情况下，README输出到stdout。您也可以将输出保存到.md文件，如下所示：

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

您还可以使用--format json选项请求JSON格式的输出：

1
rover readme fetch my-graph@my-variant --format json

有关通过stdout传递值的更多内容，请参阅约定。

将README发布到GraphOS

readme publish

您可以使用Rover将README发布到您的GraphOS图表中。

使用readme publish命令，如下所示：

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

参数my-graph@my-variant是graph ref，您可以在此处了解有关此内容。

您还可以通过提供-作为--file选项的值，通过stdin将README内容传送到

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

有关通过 stdin 接收输入的更多信息，请参阅 规范。