gen-docs

command
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 16, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Command gen-docs renders the openobserve-cli command tree into reference documentation under docs/cli/:

  • index.html — a single styled page served by GitHub Pages;
  • README.md — a module-grouped table index for browsing on GitHub.

Both are generated from the live cobra command tree (via app.NewRootCmd), so the reference can never drift from --help. Run it with `make docs`.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL