Skip to main content
Version: v5.7.0

opschain docs search

Included from Basic tier

opschain docs search <term>

Full-text search over the embedded documentation — the reference pages and the getting-started runbooks: every page's title and body is scanned case-insensitively for the term (a plain substring, not a pattern), and each matching line prints as one row —

opschain docs search "runner_lost"
PAGE                    LINE  TEXT
cli/server-restore      22    state honestly: leases that died with the backup fail fast as runner_lost
fleet-queue             87    ...

— in slug-then-line order. A term with no matches reports no reference pages match "<term>" and still exits 0. -o json|yaml emits the matches (slug, title, line, text) as a document, an empty list included.

Exit codes: 0 (matches or none), 2 for a missing or extra argument.

See also​

  • opschain docs cli/docs — read the page a match names.
  • GET /api/docs/search?q=… — the server serves the same search over the same embedded set (identical ranking; the server side additionally filters to the pages the caller may read — internal pages never match, entitlement-gated pages only with the entitlement).