beads/website/docs/cli-reference/ping.md
matt wilkie dfa8ea4813
fix(docgen): generate CLI docs in one process (#4474)
Add a bulk help docs writer that emits the root CLI reference and website command pages from a single Cobra walk. Update the shell generator to call that mode, preserve the pure-Go docs binary guard, and refresh historical versioned CLI docs only when release snapshotting requests a specific version.

Agent-Signature: codex-gpt-5.5-medium on behalf of matt wilkie
2026-06-22 18:25:58 -07:00

566 B

id title slug sidebar_position
ping bd ping /cli-reference/ping 999

Generated from bd help --doc ping

bd ping

Lightweight health check that confirms bd can reach its database.

Steps:

  1. Resolve the .beads workspace
  2. Open the store (embedded or server)
  3. Run a trivial query (issue count)
  4. Report timing

Exit 0 on success, exit 1 on failure.

Examples: bd ping # Quick connectivity check bd ping --json # Structured output for automation

bd ping [flags]