beads/docs/cli-reference/github.md
Chris Sells de0200ff77 docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard
Three generated-content defects from the adversarial review, all
structurally invisible to the drift gate (generated-vs-generated):

- Usage lines now mirror Cobra's help template: a runnable command shows
  its UseLine, a command with subcommands shows '<path> [command]', both
  when both apply. Previously bare UseLine() stamped 'bd mol [flags]' on
  30 parent pages — a line the binary never prints.
- The generated CLI index publishes the Global Flags block; the binary
  prints it on every --help but no page carried it.
- docsmint neutralizes prose lines that Mintlify's prebuild would dedent
  into MDX ESM blocks (a line beginning 'export'/'import' outside a
  fence gets wrapped in a code span). This is why /cli-reference/mail
  returned HTTP 200 while rendering only a parse-error placeholder —
  reproduced, fixed, and covered by a planted-hazard test; fenced
  content stays verbatim.

Also rewords check-cli-docs-drift.sh's early-PASS message, which
asserted 'the supplied binary differs' as the cause when uncommitted
local edits produce the same result.

All 113 pages + docs/CLI_REFERENCE.md regenerated through the pipeline;
TDD'd in cmd/bd/help_all_test.go and tools/docsmint/docsmint_test.go.
Verified live: /cli-reference/mail renders real content, zero parse
errors; generate-cli-docs.sh --check, docsync, freshness, and
mint broken-links all pass on this tree.
2026-07-12 10:37:17 -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 [command]

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