mirror of
https://github.com/gastownhall/beads.git
synced 2026-09-14 20:17:24 +08:00
Chris Sells
d2f87d50de
* docs(pipeline): pin the generated CLI docs to the released bd; repair main's CLI reference The #4874 squash-merge raced the docs-autofix bot: the bot had pushed a regeneration from main's source onto the PR branch, so the squash landed a contradictory mix — the release-aligned hand-written docs plus a CLI reference re-documenting unreleased commands and flags, with docs.json referencing four pages (heartbeat, migrate-personal, reclaim, unclaim) whose files do not exist. That broken nav fails the docsync guard on main and on every branch cut from it. This restores the intended end state of #4874 and lands the pin that prevents the race from recurring. - Regenerate the CLI reference from a bd built from the v1.1.0 tag (CI's canonical pure-Go build), removing the unreleased commands/flags and fixing the dangling nav entries. - docs/cli-docs.pin names the release tag; scripts/resolve-docs-bd.sh builds and caches a canonical pure-Go bd from that tag, fetching the tag first in shallow CI checkouts. - generate-cli-docs.sh, check-doc-flags.sh, and check-cli-docs-drift.sh resolve bd through the pin and ignore a supplied binary while pinned (BD_DOCS_IGNORE_PIN=1 bypasses), so the drift gates and the autofix bot now enforce docs-match-release instead of docs-match-main. - tools/docsmint detects the pre-overhaul Docusaurus staging layout that bd <= v1.1.0 emits and converts it to the generic form before its normal Mintlify transform (tested); removable once the pin reaches a release whose emitter writes build/cli-docs. - check-doc-flags.sh: run without timeout(1) on macOS instead of failing Check 4. - Decision record: engdocs/decisions/2026-07-17-docs-release-pin.md; the beads-docs skill §8 updated to match. * lint: annotate gosec G705 false positive in the docsmint legacy bridge Same class as the existing nav-splice annotation: a developer tool writing repo Markdown, not a web-output sink.
48 lines
1.8 KiB
Markdown
48 lines
1.8 KiB
Markdown
---
|
|
title: "bd export"
|
|
description: "Export all issues to JSONL (newline-delimited JSON) format."
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --doc export`.
|
|
|
|
Export all issues to JSONL (newline-delimited JSON) format.
|
|
|
|
Each line is a complete JSON object representing one issue, including its
|
|
labels, dependencies, and comments.
|
|
|
|
This command is for issue export, migration, and interoperability. It exports
|
|
records from the issues table; it is not a full database backup and does not
|
|
capture Dolt branches, commit history, working-set state, or non-issue tables.
|
|
For supported full backup/restore flows, use 'bd backup init', 'bd backup sync',
|
|
and 'bd backup restore'.
|
|
|
|
By default, exports only regular issues (excluding infrastructure beads
|
|
like agents, roles, and messages). Use --all to include everything.
|
|
|
|
Memories (from 'bd remember') are excluded by default because they may
|
|
contain sensitive agent context. Use --include-memories or --all to
|
|
include them.
|
|
|
|
EXAMPLES:
|
|
bd export # Export issues to stdout
|
|
bd export -o issues.jsonl # Export issues to file
|
|
bd export --include-memories # Export issues + memories
|
|
bd export --all -o full.jsonl # Include infra + templates + gates + memories
|
|
bd export --scrub -o clean.jsonl # Exclude test/pollution records
|
|
|
|
```
|
|
bd export [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--all Include all records (infra, templates, gates, memories)
|
|
--include-infra Include infrastructure beads (agents, roles, messages)
|
|
--include-memories Include persistent memories (from 'bd remember') in the export
|
|
-o, --output string Output file path (default: stdout)
|
|
--scrub Exclude test/pollution records
|
|
```
|