Skip to main content
Version: v5.7.1

opschain docs

Included from Basic tier

opschain docs [page]

Read the OpsChain reference documentation — component taxonomy, data dictionary, CLI manual, concept pages and the getting-started guide — embedded in this binary, so the reference always matches the opschain version you are running. A bare opschain docs prints the index grouped by kind (-o json|yaml emits the page list instead); opschain docs <page> prints one page, addressed by its slug (opschain docs fleet-queue, opschain docs cli/runs-create, opschain docs getting-started/4-1-anatomy-and-the-step-kinds — a trailing .md is tolerated). The learning-path lessons are the same set opschain learn reads (which also addresses them by lesson id, module or track); the retired chapter slugs have no aliases. The output is plain text and reads well through a pager (opschain docs cli/runs-create | less). An unknown slug errors naming every valid page (exit 1).

SubcommandManualPurpose
search <term>opschain docs cli/docs-searchFull-text search over the embedded pages
exportopschain docs cli/docs-exportWrite the embedded set to a directory

Commands whose manual page ships in this tree say so at the end of their --help text (Full manual: opschain docs cli/<slug>).

Page visibility (entitlement and audience gating)​

Two optional front-matter keys gate where a page renders; the same filter backs every user-facing surface (opschain docs/learn, GET /api/docs and the GUI Help it feeds):

  • entitlement: packs:<name> — the page documents a licensed pack. A server (and the GUI it serves) lists and serves the page only when the effective licence carries that entitlement; this offline embedded copy renders it regardless, prefixed with a banner naming the requirement, because the binary cannot see a licence.
  • audience: internal — engineering evidence pages. Never listed, rendered, searched or (by default) exported on any user-facing surface; opschain docs export --internal writes them.

Entitlement gating is UX relevance, not security: every page ships in every binary (this offline copy proves it), and hiding one from an unentitled server's surfaces only keeps the index relevant to what that estate can actually use — it protects nothing.

See also​

  • opschain docs cli/learn — the learning path, same embedding.