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
91 lines
2.4 KiB
Markdown
91 lines
2.4 KiB
Markdown
---
|
|
id: hooks
|
|
title: bd hooks
|
|
slug: /cli-reference/hooks
|
|
sidebar_position: 999
|
|
---
|
|
|
|
<!-- AUTO-GENERATED: do not edit manually -->
|
|
Generated from `bd help --doc hooks`
|
|
|
|
## bd 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]
|
|
```
|