Skip to content

vor show doc

vor show doc

Print a page of the bundled VOR Stream user guide

Synopsis

Print a page of the VOR Stream user guide bundled into this vor binary.

Pages are addressed by their guide-relative path, for example "vor show doc sdk/model.md". The bundled guide matches this binary's version. Add --files to list every embedded page; start at "index.md".

Output is raw when piped or redirected; Markdown may be rendered for readability when written to a terminal.

vor show doc [path] [flags]

Options

      --files   list every embedded user-guide page
  -h, --help    help for doc

Options inherited from parent commands

      --play string   playpen path
      --renew-token   renew token (default true)

SEE ALSO