astarte-docs-cli

A CLI to manage Astarte documentation.

Usage

$ npm install -g @astarte-platform/astarte-docs-cli
$ astarte-docs COMMAND
running command...
$ astarte-docs (--version)
@astarte-platform/astarte-docs-cli/0.0.7 linux-x64 node-v16.13.0
$ astarte-docs --help [COMMAND]
USAGE
  $ astarte-docs COMMAND
...

Commands

• astarte-docs help [COMMAND]
• astarte-docs interfaces gen-markdown

astarte-docs help [COMMAND]

Display help for astarte-docs.

USAGE
  $ astarte-docs help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for astarte-docs.

See code: @oclif/plugin-help

astarte-docs interfaces gen-markdown

Generate Markdown documentation from Astarte interfaces

USAGE
  $ astarte-docs interfaces gen-markdown [-f <value> | -d <value> | -u <value>] [-o <value> | --outputDirectory <value>] [-t
    <value>]

FLAGS
  -d, --fromDirectory=<value>  Input directory containing interface definitions in JSON format
  -f, --fromFile=<value>       Input file containing an interface definition in JSON format
  -o, --outputFile=<value>     Output file that will contain the generated Markdown
  -t, --template=<value>       Mustache template file to use when generating Markdown
  -u, --fromUrl=<value>        Input URL containing an interface definition in JSON format
  --outputDirectory=<value>    Output directory that will contain the generated Markdown files

DESCRIPTION
  Generate Markdown documentation from Astarte interfaces

EXAMPLES
  $ astarte-docs interfaces gen-markdown -d ./interfaces -o ./interfaces.md