beads/docs/cli-reference/github.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.3 KiB

title description
bd github GitHub integration commands

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

Generated from bd help --doc github.

Commands for syncing issues between beads and GitHub.

Configuration can be set via 'bd config' or environment variables: github.token / GITHUB_TOKEN - Personal access token github.owner / GITHUB_OWNER - Repository owner github.repo / GITHUB_REPO - Repository name github.repository / GITHUB_REPOSITORY - Combined "owner/repo" format github.url / GITHUB_API_URL - Custom API URL (GitHub Enterprise)

bd github [flags]

bd github pull

Pull one or more items from GitHub.

Accepts bead IDs or external references as positional arguments. Equivalent to: bd github sync --pull-only --issues <refs>

bd github pull [refs...] [flags]

Flags:

      --dry-run   Preview pull without making changes

bd github push

Push one or more beads issues to GitHub.

Accepts bead IDs as positional arguments. Equivalent to: bd github sync --push-only --issues <ids>

bd github push [bead-ids...] [flags]

Flags:

      --dry-run   Preview push without making changes

bd github repos

List GitHub repositories that the configured token has access to.

bd github repos [flags]

bd github status

Display current GitHub configuration and sync status.

bd github status [flags]

bd github sync

Synchronize issues between beads and GitHub.

By default, performs bidirectional sync:

  • Pulls new/updated issues from GitHub to beads
  • Pushes local beads issues to GitHub

Use --pull-only or --push-only to limit direction.

bd github sync [flags]

Flags:

      --dry-run         Show what would be synced without making changes
      --issues string   Comma-separated bead IDs to sync selectively (e.g., bd-abc,bd-def). Mutually exclusive with --parent.
      --parent string   Limit push to this bead and its descendants (push only). Mutually exclusive with --issues.
      --prefer-github   On conflict, use GitHub version
      --prefer-local    On conflict, keep local beads version
      --prefer-newer    On conflict, use most recent version (default)
      --pull-only       Only pull issues from GitHub
      --push-only       Only push issues to GitHub