beads/website/docs/cli-reference/preflight.md
Jim Wordelman 3e10077dc5
feat(preflight): implement --fix mode for vendorHash and version sync (#4054)
* feat(preflight): implement --fix mode for vendorHash and version sync

- Add fixNixHash(): uses sentinel-hash trick with nix build to compute
  and write the correct vendorHash into default.nix when go.sum has
  uncommitted changes; prints clear error if nix not in PATH
- Add fixVersionSync(): syncs cmd/bd/version.go to match default.nix
  version field (default.nix is source of truth)
- Add runFixes(): wires both to --fix flag with human-readable and
  --json output modes
- Remove outdated 'not yet implemented / bd-lfak.3-5' stub
- Preserve original file permissions on all writes

Closes be-xra8, be-roho

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: sync CLI_REFERENCE.md --fix help text with live CLI (be-xra8, be-roho)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(preflight): regenerate website CLI reference for --fix flag (be-laor)

Update website/docs and both versioned_docs variants to reflect --fix
flag description change from 'not yet implemented' to 'vendorHash, version sync'.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore: release gate PASS for be-xra8+be-roho (bd preflight --fix mode)

---------

Co-authored-by: Jim Wordelman <jim@wordelman.name>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: matt wilkie <maphew@gmail.com>
2026-07-06 22:33:29 -07:00

969 B

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

Generated from bd help --doc preflight

bd preflight

Display a checklist of common pre-PR checks for contributors.

This command helps catch common issues before pushing to CI:

  • Tests not run locally
  • Lint errors
  • Unformatted Go files
  • .beads/issues.jsonl pollution
  • Stale nix vendorHash
  • Version mismatches

Examples: bd preflight # Show checklist bd preflight --check # Run checks automatically bd preflight --check --json # JSON output for programmatic use bd preflight --check --skip-lint # Explicitly skip lint check

bd preflight [flags]

Flags:

      --check       Run checks automatically
      --fix         Auto-fix issues where possible (vendorHash, version sync)
      --json        Output results as JSON
      --skip-lint   Skip lint check explicitly