快速开始

两分钟内从安装到创建第一个工作区。Beadbox 封装了 bd CLI,因此两者都需要安装。

1安装 beads CLI

bd 命令是 Beadbox 的核心引擎。它使用 Git 存储在本地管理你的问题、epic 和依赖关系。

brew install beads

需要 Homebrew。将 bd 二进制文件安装到 PATH。

验证安装:

bd --version

你应该看到版本号输出。如果提示命令未找到,请确保安装目录在 PATH 中。

2安装 Beadbox

Beadbox 是原生桌面应用。选择适合你平台的安装包。

brew tap beadbox/cask && brew install --cask beadbox

也可以直接从 GitHub Releases 下载 DMG。

3首次启动

打开 Beadbox。接下来的步骤取决于你的环境。

初次使用 beads?还没有工作区?

Beadbox 启动时会检查 bd CLI。如果找不到,你会看到一个带安装说明和"再次检查"按钮的欢迎页面。

检测到 bd 后,你会看到 快速开始 卡片。选择一个项目文件夹,点击 设置工作区,Beadbox 会自动运行 bd。工作区准备就绪,所有数据保留在本地。

已经在使用 bd?有现有的工作区?

Beadbox 从 ~/.beads/registry.json 和包含 .beads/ 文件夹的项目目录中检测工作区。点击工作区即可打开。Epic 树会加载实时状态指示器。

终端的变更实时传播。在终端运行 bd update <id> --status closed,两秒内即可看到 Beadbox 中的状态更新,无需手动刷新。

4界面介绍

主界面分为三个区域:

Beadbox 主界面,左侧是 epic 树,右侧是详情面板,顶部是过滤栏

顶部栏

切换工作区、查看连接状态和手动刷新。键盘快捷键设置也在这里。

过滤栏

按状态、优先级、负责人或全文搜索进行过滤。按更新时间、创建时间、优先级或状态排序。过滤设置按工作区保留。

Epic 树(左侧)

Epic 及其子项的层级视图。展开可查看状态徽章、优先级指示器和进度计数。点击任意 bead 查看详情。

详情面板(右侧)

完整的 bead 元数据:描述、评论、依赖关系、验收标准,全部以 markdown 渲染。

后续步骤