beads/docs/cli-reference/hooks.md
Chris Sells 4ea6fa3ac0 docs(emitter): emit Mintlify CLI reference and generated docs.json nav
bd help --docs-root now additionally writes docs/cli-reference/ in Mintlify
form (frontmatter title as H1, extensionless root-relative links, JSX
auto-generated markers since Mintlify parses .md through MDX) and rewrites
the CLI Reference pages array inside docs/docs.json via a textual splice
that leaves the rest of the file byte-identical — the ~113 nav entries are
never hand-maintained. The Docusaurus outputs (docs/CLI_REFERENCE.md,
website/docs/cli-reference/, versioned snapshots) are unchanged.

generate-cli-docs.sh --check seeds docs/docs.json and docs/cli-reference/
into its scratch root and diffs both; check-cli-docs-drift.sh adds them to
GEN_PATHSPECS and the regeneration fingerprint; docs-autofix-push.sh
allowlists the new generated paths; check-doc-flags.sh scans the new
docs/ subdirectories and requires command coverage in docs/cli-reference/.

Includes the initial docs/docs.json scaffold (nav mirrors the Docusaurus
sidebar IA) and the generated docs/cli-reference/ pages.

TDD: new emitter behavior covered in cmd/bd/help_all_test.go
(Mintlify page format, nav splice correctness + idempotence, bare-root
generation without docs.json).
2026-07-12 10:37:07 -07:00

2.4 KiB

title description
bd hooks Manage git hooks for beads integration

{/* AUTO-GENERATED: do not edit manually */}

Generated from bd help --doc hooks.

Install, uninstall, or list git hooks for beads integration.

The hooks provide:

  • pre-commit: Run chained hooks before commit
  • post-merge: Run chained hooks after pull/merge
  • pre-push: Run chained hooks before push
  • post-checkout: Run chained hooks after branch checkout
  • prepare-commit-msg: Add agent identity trailers for forensics
bd hooks [flags]

bd hooks install

Install git hooks for beads integration.

By default, hooks are installed to .git/hooks/ in the current repository. Use --beads to install to .beads/hooks/ (recommended for Dolt backend). Use --shared to install to a versioned directory (.beads-hooks/) that can be committed to git and shared with team members.

Hooks use section markers to coexist with existing hooks — any user content outside the markers is preserved across installs and upgrades.

Installed hooks:

  • pre-commit: Run chained hooks before commit
  • post-merge: Run chained hooks after pull/merge
  • pre-push: Run chained hooks before push
  • post-checkout: Run chained hooks after branch checkout
  • prepare-commit-msg: Add agent identity trailers (for orchestrator agents)
bd hooks install [flags]

Flags:

      --beads    Install hooks to .beads/hooks/ (recommended for Dolt backend)
      --chain    Chain with existing hooks (run them before bd hooks)
      --force    Overwrite existing hooks without backup
      --shared   Install hooks to .beads-hooks/ (versioned) instead of .git/hooks/

bd hooks list

Show the status of bd git hooks (installed, outdated, missing).

bd hooks list [flags]

bd hooks run

Execute the logic for a git hook. This command is typically called by thin shim scripts installed in .git/hooks/.

Supported hooks:

  • pre-commit: Run chained hooks before commit
  • post-merge: Run chained hooks after pull/merge
  • pre-push: Run chained hooks before push
  • post-checkout: Run chained hooks after branch checkout
  • prepare-commit-msg: Add agent identity trailers for forensics

The thin shim pattern ensures hook logic is always in sync with the installed bd version - upgrading bd automatically updates hook behavior.

bd hooks run <hook-name> [args...] [flags]

bd hooks uninstall

Remove bd git hooks from .git/hooks/ directory.

bd hooks uninstall [flags]