diff --git a/README.md b/README.md index d5404ae..a41d732 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,18 @@ ## 安装 ```bash -bunx rune init opencode +bunx @lanyuanxiaoyao/rune init opencode ``` +如果没有安装 bun,可使用 `pnpx @lanyuanxiaoyao/rune` 或 `npx @lanyuanxiaoyao/rune` 替代。 + ## 使用 ### 初始化 ```bash -bunx rune init opencode # OpenCode 编辑器 -bunx rune init claude-code # Claude Code 编辑器 +bunx @lanyuanxiaoyao/rune init opencode # OpenCode 编辑器 +bunx @lanyuanxiaoyao/rune init claude-code # Claude Code 编辑器 ``` 会在项目中创建: @@ -27,8 +29,8 @@ bunx rune init claude-code # Claude Code 编辑器 当 Rune 版本升级后,需要更新已注入的命令和 skill 文件: ```bash -bunx rune update opencode # 更新 OpenCode 的命令和 skill -bunx rune update claude-code # 更新 Claude Code 的命令 +bunx @lanyuanxiaoyao/rune update opencode # 更新 OpenCode 的命令和 skill +bunx @lanyuanxiaoyao/rune update claude-code # 更新 Claude Code 的命令 ``` 更新策略:对比文件内容,不一致则用内置版本覆盖;不存在则新建。 @@ -45,29 +47,29 @@ SDD 工作流包含固定的四个阶段,不可自定义增删: ### 状态查看 ```bash -rune status # 查看所有变更(含各阶段文档完成状态、下一步建议) -rune status <变更名> # 查看指定变更的详细状态 +bunx @lanyuanxiaoyao/rune status # 查看所有变更(含各阶段文档完成状态、下一步建议) +bunx @lanyuanxiaoyao/rune status <变更名> # 查看指定变更的详细状态 ``` -规划阶段应引导 AI 先通过 `rune status` 获取当前有哪些文档需要编写。 +规划阶段应引导 AI 先通过 `bunx @lanyuanxiaoyao/rune status` 获取当前有哪些文档需要编写。 ### 命令参考 ```bash -rune help # 显示全局帮助 -rune help # 显示指定命令的详细帮助 -rune version # 显示版本号 +bunx @lanyuanxiaoyao/rune help # 显示全局帮助 +bunx @lanyuanxiaoyao/rune help # 显示指定命令的详细帮助 +bunx @lanyuanxiaoyao/rune version # 显示版本号 ``` -| 命令 | 说明 | -| ----------------------------- | ----------------------------------------------- | -| `rune init ` | 初始化项目,注入编辑器配置 | -| `rune update ` | 更新编辑器的命令和 skill 文件 | -| `rune discuss` | 输出讨论阶段提示词 | -| `rune plan <变更名> <文档名>` | 输出规划阶段提示词 | -| `rune build <变更名>` | 输出构建阶段提示词 | -| `rune archive <变更名>` | 输出归档阶段提示词,同时移动变更目录到 archive/ | -| `rune status [变更名]` | 显示变更状态和下一步建议 | +| 命令 | 说明 | +| -------------------------------------------------- | ----------------------------------------------- | +| `bunx @lanyuanxiaoyao/rune init ` | 初始化项目,注入编辑器配置 | +| `bunx @lanyuanxiaoyao/rune update ` | 更新编辑器的命令和 skill 文件 | +| `bunx @lanyuanxiaoyao/rune discuss` | 输出讨论阶段提示词 | +| `bunx @lanyuanxiaoyao/rune plan <变更名> <文档名>` | 输出规划阶段提示词 | +| `bunx @lanyuanxiaoyao/rune build <变更名>` | 输出构建阶段提示词 | +| `bunx @lanyuanxiaoyao/rune archive <变更名>` | 输出归档阶段提示词,同时移动变更目录到 archive/ | +| `bunx @lanyuanxiaoyao/rune status [变更名]` | 显示变更状态和下一步建议 | ### 自定义配置