beads/website/docs/cli-reference/repo.md
matt wilkie b2a4d1d04a
docs: generate CLI reference from live help (#3704)
* docs: generate CLI reference from live help

* docs(cli): move bd version stamp from per-command pages to index only

Drops the `(bd version X.Y.Z)` suffix from the auto-generated header on
every per-command CLI reference page (writeSingleCommandDoc) and the
docs/CLI_REFERENCE.md preamble (writeAllHelp). The version label now
lives only on the index page emitted by scripts/generate-cli-docs.sh:

- Dev tree (website/docs/cli-reference/index.md, docs/CLI_REFERENCE.md):
  labelled "Latest"
- Versioned snapshots (website/versioned_docs/version-X.Y.Z/...):
  labelled with the explicit semver tag parsed from the directory name

This eliminates the 100+-file no-signal diff a release version bump
otherwise produces, restoring the "regen as a separate small commit"
workflow PR #3704 enables. After this change a version bump alone
yields zero diff on the dev tree; only the new versioned snapshot
created at release-cut time carries the new tag. No datestamps are
introduced anywhere — scripts/generate-cli-docs.sh --check remains
deterministic across CI runs.

Refs: mybd-afb, PR #3704

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: CI Bot <ci@beads.test>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-05 19:43:49 -07:00

2.4 KiB

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

Generated from bd help --doc repo

bd repo

Configure and manage multiple repository support for multi-repo hydration.

Multi-repo support allows hydrating issues from multiple beads repositories into a single database for unified cross-repo issue tracking.

Configuration is stored in .beads/config.yaml under the 'repos' section:

repos: primary: "." additional: - ~/beads-planning - ~/work-repo

Examples: bd repo add ~/beads-planning # Add planning repo bd repo add ../other-repo # Add relative path repo bd repo list # Show all configured repos bd repo remove ~/beads-planning # Remove by path bd repo sync # Sync from all configured repos

bd repo

bd repo add

Add a repository path to the repos.additional list in config.yaml.

The path should point to a directory containing a .beads folder. Paths can be absolute or relative (they are stored as-is).

This modifies .beads/config.yaml, which is version-controlled and shared across all clones of this repository.

bd repo add <path> [flags]

Flags:

      --json   Output JSON

bd repo list

List all repositories configured in .beads/config.yaml.

Shows the primary repository (always ".") and any additional repositories configured for hydration.

bd repo list [flags]

Flags:

      --json   Output JSON

bd repo remove

Remove a repository path from the repos.additional list in config.yaml.

The path must exactly match what was added (e.g., if you added "/foo", you must remove "/foo", not "/home/user/foo").

This command also removes any previously-hydrated issues from the database that came from the removed repository.

bd repo remove <path> [flags]

Flags:

      --json   Output JSON

bd repo sync

Synchronize issues from all configured additional repositories.

Reads issues.jsonl from each additional repository and imports them into the primary database with their original prefixes and source_repo set. Uses mtime caching to skip repos whose JSONL hasn't changed.

Also triggers Dolt push/pull if a remote is configured.

bd repo sync [flags]

Flags:

      --json      Output JSON
      --verbose   Show detailed sync progress