* 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>
123 lines
3.4 KiB
Markdown
123 lines
3.4 KiB
Markdown
---
|
|
id: jira
|
|
title: bd jira
|
|
slug: /cli-reference/jira
|
|
sidebar_position: 999
|
|
---
|
|
|
|
<!-- AUTO-GENERATED: do not edit manually -->
|
|
Generated from `bd help --doc jira`
|
|
|
|
## bd jira
|
|
|
|
Synchronize issues between beads and Jira.
|
|
|
|
Configuration:
|
|
bd config set jira.url "https://company.atlassian.net"
|
|
bd config set jira.project "PROJ"
|
|
bd config set jira.projects "PROJ1,PROJ2" # Multiple projects
|
|
bd config set jira.api_token "YOUR_TOKEN"
|
|
bd config set jira.username "your_email@company.com" # For Jira Cloud
|
|
bd config set jira.push_prefix "hippo" # Only push hippo-* issues to Jira
|
|
bd config set jira.push_prefix "proj1,proj2" # Multiple prefixes (comma-separated)
|
|
|
|
Environment variables (alternative to config):
|
|
JIRA_API_TOKEN - Jira API token
|
|
JIRA_USERNAME - Jira username/email
|
|
JIRA_PROJECTS - Comma-separated project keys
|
|
|
|
Examples:
|
|
bd jira sync --pull # Import issues from Jira
|
|
bd jira sync --push # Export issues to Jira
|
|
bd jira sync # Bidirectional sync (pull then push)
|
|
bd jira sync --dry-run # Preview sync without changes
|
|
bd jira status # Show sync status
|
|
|
|
```
|
|
bd jira
|
|
```
|
|
|
|
### bd jira pull
|
|
|
|
Pull one or more items from Jira.
|
|
|
|
Accepts bead IDs or external references as positional arguments.
|
|
Equivalent to: bd jira sync --pull --issues <refs>
|
|
|
|
```
|
|
bd jira pull [refs...] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--dry-run Preview pull without making changes
|
|
```
|
|
|
|
### bd jira push
|
|
|
|
Push one or more beads issues to Jira.
|
|
|
|
Accepts bead IDs as positional arguments.
|
|
Equivalent to: bd jira sync --push --issues <ids>
|
|
|
|
```
|
|
bd jira push [bead-ids...] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--dry-run Preview push without making changes
|
|
```
|
|
|
|
### bd jira status
|
|
|
|
Show the current Jira sync status, including:
|
|
- Last sync timestamp
|
|
- Configuration status
|
|
- Number of issues with Jira links
|
|
- Issues pending push (no external_ref)
|
|
|
|
```
|
|
bd jira status
|
|
```
|
|
|
|
### bd jira sync
|
|
|
|
Synchronize issues between beads and Jira.
|
|
|
|
Modes:
|
|
--pull Import issues from Jira into beads
|
|
--push Export issues from beads to Jira
|
|
(no flags) Bidirectional sync: pull then push, with conflict resolution
|
|
|
|
Conflict Resolution:
|
|
By default, newer timestamp wins. Override with:
|
|
--prefer-local Always prefer local beads version
|
|
--prefer-jira Always prefer Jira version
|
|
|
|
Examples:
|
|
bd jira sync --pull # Import from Jira
|
|
bd jira sync --push --create-only # Push new issues only
|
|
bd jira sync --dry-run # Preview without changes
|
|
bd jira sync --prefer-local # Bidirectional, local wins
|
|
|
|
```
|
|
bd jira sync [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--create-only Only create new issues, don't update existing
|
|
--dry-run Preview sync 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-jira Prefer Jira version on conflicts
|
|
--prefer-local Prefer local version on conflicts
|
|
--project strings Project key(s) to sync (overrides configured project/projects)
|
|
--pull Pull issues from Jira
|
|
--push Push issues to Jira
|
|
--state string Issue state to sync: open, closed, all (default "all")
|
|
```
|