* 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>
101 lines
2.3 KiB
Markdown
101 lines
2.3 KiB
Markdown
---
|
|
id: github
|
|
title: bd github
|
|
slug: /cli-reference/github
|
|
sidebar_position: 999
|
|
---
|
|
|
|
<!-- AUTO-GENERATED: do not edit manually -->
|
|
Generated from `bd help --doc github`
|
|
|
|
## bd 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
|
|
```
|
|
|
|
### 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
|
|
```
|
|
|
|
### bd github status
|
|
|
|
Display current GitHub configuration and sync status.
|
|
|
|
```
|
|
bd github status
|
|
```
|
|
|
|
### 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
|
|
```
|