tree: 6a4baaa84fb053d408e004ed1ff42598303d0624 [path history] [tgz]
  1. BUILD.gn
  2. OWNERS
  3. README.md
  4. src/
tools/clidoc/README.md

CliDoc is a command-line tool that generates documentation for core Fuchsia developer tools based on their --help output

Build

  1. Include clidoc by adding a direct or indirect reference to it in your fx set (e.g. fx set core.x64 --with //tools/clidoc)
  2. Build with fx build tools/clidoc:clidoc

Run

  1. Run with fx clidoc

WIP

This tool is a work in progress and currently being actively developed. Next steps are to generate a markdown file of the collected developer tool --help output, which will be the basis for the reference documentation on fuchsia.dev