beads

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Beads Issue Tracker

Beads 问题跟踪器

Git-backed issue tracking with dependency awareness. Perfect for agent task management.
基于Git的、具备依赖感知能力的问题跟踪工具。非常适合Agent任务管理。

Prerequisites

前提条件

Install beads:
bash
undefined
安装Beads:
bash
undefined

Install via cargo or download binary

Install via cargo or download binary

cargo install beads
cargo install beads

Or download from releases

Or download from releases


Initialize in a project:
```bash
bd init

在项目中初始化:
```bash
bd init

CLI Reference

CLI 参考

View Ready Work

查看可开始的工作

bash
undefined
bash
undefined

Get issues with no blockers

Get issues with no blockers

bd ready --json
bd ready --json

Filter by assignee

Filter by assignee

bd ready --assignee username --json
bd ready --assignee username --json

Filter by label

Filter by label

bd ready --label "urgent" --json
bd ready --label "urgent" --json

Limit results

Limit results

bd ready --limit 5 --json
undefined
bd ready --limit 5 --json
undefined

Create Issues

创建问题

bash
undefined
bash
undefined

Basic task

Basic task

bd create "Task title" --json
bd create "Task title" --json

With details

With details

bd create "Task title" -d "Description" -t task -p 2 --json
bd create "Task title" -d "Description" -t task -p 2 --json

As subtask of epic

As subtask of epic

bd create "Subtask" --parent epic-123 --force --json
bd create "Subtask" --parent epic-123 --force --json

With dependencies

With dependencies

bd create "Task" --deps "other-issue-id" --json
bd create "Task" --deps "other-issue-id" --json

Quick mode (less output)

Quick mode (less output)

bd create "Task" -q --json
undefined
bd create "Task" -q --json
undefined

Issue Types

问题类型

  • bug
    - Bug reports
  • feature
    - New features
  • task
    - General tasks
  • epic
    - Parent containers
  • chore
    - Maintenance work
  • bug
    - 漏洞报告
  • feature
    - 新功能
  • task
    - 常规任务
  • epic
    - 父级任务容器
  • chore
    - 维护工作

Priority Levels

优先级等级

  • 0
    - Critical
  • 1
    - High
  • 2
    - Normal (default)
  • 3
    - Low
  • 4
    - Backlog
  • 0
    - 严重
  • 1
    - 高
  • 2
    - 正常(默认)
  • 3
    - 低
  • 4
    - 待办积压

Update Issues

更新问题

bash
undefined
bash
undefined

Change status

Change status

bd update issue-id -s in_progress --json
bd update issue-id -s in_progress --json

Add notes

Add notes

bd update issue-id --notes "Progress update" --json
bd update issue-id --notes "Progress update" --json

Change priority

Change priority

bd update issue-id -p 1 --json
bd update issue-id -p 1 --json

Add labels

Add labels

bd update issue-id --add-label "urgent" --json
undefined
bd update issue-id --add-label "urgent" --json
undefined

Close Issues

关闭问题

bash
undefined
bash
undefined

Close with reason

Close with reason

bd close issue-id -r "Completed successfully" --json
undefined
bd close issue-id -r "Completed successfully" --json
undefined

List Issues

列出问题

bash
undefined
bash
undefined

All open issues

All open issues

bd list --status open --json
bd list --status open --json

Filter by type

Filter by type

bd list --type bug --json
bd list --type bug --json

Filter by assignee

Filter by assignee

bd list --assignee "username" --json
bd list --assignee "username" --json

Filter by label

Filter by label

bd list --label "backend" --json
bd list --label "backend" --json

Filter by priority

Filter by priority

bd list --priority 1 --json
undefined
bd list --priority 1 --json
undefined

Show Issue Details

查看问题详情

bash
bd show issue-id --json
bash
bd show issue-id --json

Dependencies

依赖项

bash
undefined
bash
undefined

Add dependency (issue-a depends on issue-b)

Add dependency (issue-a depends on issue-b)

bd dep add issue-a issue-b
bd dep add issue-a issue-b

Dependency types: blocks, related, parent-child, discovered-from

Dependency types: blocks, related, parent-child, discovered-from

bd dep add issue-a issue-b -t blocks
undefined
bd dep add issue-a issue-b -t blocks
undefined

Sync with Git

与Git同步

bash
undefined
bash
undefined

Sync issues to git remote

Sync issues to git remote

bd sync
undefined
bd sync
undefined

Hygiene Commands

清理命令

bash
undefined
bash
undefined

Find duplicate issues

Find duplicate issues

bd duplicates --dry-run
bd duplicates --dry-run

Auto-merge duplicates

Auto-merge duplicates

bd duplicates --auto-merge
bd duplicates --auto-merge

Find stale issues (no activity)

Find stale issues (no activity)

bd stale --days 14 --json
bd stale --days 14 --json

Cleanup old closed issues

Cleanup old closed issues

bd cleanup --dry-run bd cleanup -f
undefined
bd cleanup --dry-run bd cleanup -f
undefined

Install Git Hooks

安装Git钩子

bash
undefined
bash
undefined

Auto-sync on commit

Auto-sync on commit

bd hooks install
undefined
bd hooks install
undefined

System Info

系统信息

bash
undefined
bash
undefined

Check version

Check version

bd --version
bd --version

Project info

Project info

bd info --json
undefined
bd info --json
undefined

Workflow Patterns

工作流模式

Session Start

会话开始

bash
undefined
bash
undefined

See what's ready to work on

See what's ready to work on

bd ready --json
undefined
bd ready --json
undefined

Working on a Task

处理任务时

bash
undefined
bash
undefined

Start working

Start working

bd update task-id -s in_progress --json
bd update task-id -s in_progress --json

Add progress notes

Add progress notes

bd update task-id --notes "Halfway done" --json
bd update task-id --notes "Halfway done" --json

Complete

Complete

bd close task-id -r "Implemented and tested" --json
undefined
bd close task-id -r "Implemented and tested" --json
undefined

Epic Planning

史诗任务规划

bash
undefined
bash
undefined

Create epic

Create epic

bd create "User Authentication" -t epic --json
bd create "User Authentication" -t epic --json

Add subtasks

Add subtasks

bd create "Design auth flow" --parent auth-epic --force --json bd create "Implement login" --parent auth-epic --force --json bd create "Add tests" --parent auth-epic --force --json
bd create "Design auth flow" --parent auth-epic --force --json bd create "Implement login" --parent auth-epic --force --json bd create "Add tests" --parent auth-epic --force --json

Add dependencies between subtasks

Add dependencies between subtasks

bd dep add implement-id design-id -t blocks bd dep add tests-id implement-id -t blocks
undefined
bd dep add implement-id design-id -t blocks bd dep add tests-id implement-id -t blocks
undefined

End of Session

会话结束

bash
undefined
bash
undefined

Sync to git

Sync to git

bd sync
undefined
bd sync
undefined

Worktree Mode

工作树模式

When using git worktrees, disable the daemon:
bash
export BEADS_NO_DAEMON=1
使用git工作树时,禁用守护进程:
bash
export BEADS_NO_DAEMON=1

Or per-command

Or per-command

bd --no-daemon ready --json
undefined
bd --no-daemon ready --json
undefined

Best Practices

最佳实践

  1. Always use
    --json
    for parseable output
  2. Use
    bd ready
    at session start to see unblocked work
  3. Add dependencies to express task relationships
  4. Use epics for grouping related tasks
  5. Run
    bd sync
    before ending sessions
  6. Install hooks for automatic sync:
    bd hooks install
  1. **始终使用
    --json
    **以获得可解析的输出
  2. **使用
    bd ready
    **在会话开始时查看无阻塞的工作
  3. 添加依赖项以表达任务间的关系
  4. 使用史诗任务对相关任务进行分组
  5. **运行
    bd sync
    **在会话结束前
  6. 安装钩子以实现自动同步:
    bd hooks install