Ralphy

加入我们的 Discord - 有疑问吗？想要参与贡献？加入我们的社区吧！

自动化的 AI 编码循环工具。通过运行 AI Agent 执行任务，直至全部完成。

安装

选项 A：npm（推荐）

npm install -g ralphy-cli

# 然后可在任何位置使用
ralphy "add login button"
ralphy --prd PRD.md

选项 B：克隆仓库

git clone https://github.com/michaelshimeles/ralphy.git
cd ralphy && chmod +x ralphy.sh

./ralphy.sh "add login button"
./ralphy.sh --prd PRD.md

两个版本的特性完全一致。下文示例均使用 ralphy (npm) - 如果使用 bash 脚本，请将其替换为 ./ralphy.sh。

两种模式

单任务模式 - 只需告诉它要做什么：

ralphy "add dark mode"
ralphy "fix the auth bug"

任务列表模式 - 根据 PRD 完成工作：

ralphy              # 使用 PRD.md
ralphy --prd tasks.md

项目配置

可选。用于存储 AI 必须遵循的规则。

ralphy --init              # 自动检测项目设置
ralphy --config            # 查看配置
ralphy --add-rule "use TypeScript strict mode"

创建 .ralphy/config.yaml 文件：

project:
  name: "my-app"
  language: "TypeScript"
  framework: "Next.js"

commands:
  test: "npm test"
  lint: "npm run lint"
  build: "npm run build"

rules:
  - "use server actions not API routes"
  - "follow error pattern in src/utils/errors.ts"

boundaries:
  never_touch:
    - "src/legacy/**"
    - "*.lock"

规则适用于所有任务（单任务或 PRD 任务）。

AI 引擎

ralphy              # Claude Code (默认)
ralphy --opencode   # OpenCode
ralphy --cursor     # Cursor
ralphy --codex      # Codex
ralphy --qwen       # Qwen-Code
ralphy --droid      # Factory Droid
ralphy --copilot    # GitHub Copilot
ralphy --gemini     # Gemini CLI

模型覆盖

为任何引擎覆盖默认模型：

ralphy --model sonnet "add feature"                    # 在 Claude 中使用 sonnet
ralphy --sonnet "add feature"                          # 上述命令的快捷方式
ralphy --opencode --model opencode/glm-4.7-free "task" # 自定义 OpenCode 模型
ralphy --qwen --model qwen-max "build api"             # 自定义 Qwen 模型

引擎特定参数

使用 -- 分隔符将附加参数传递给底层的引擎 CLI：

# 传递 Copilot 特定参数
ralphy --copilot --model "claude-opus-4.5" --prd PRD.md -- --allow-all-tools --allow-all-urls --stream on

# 传递 Claude 特定参数  
ralphy --claude "add feature" -- --no-permissions-prompt

# 适用于任何引擎
ralphy --cursor "fix bug" -- --custom-arg value

-- 之后的所有内容都将直接传递给引擎 CLI，不进行转译。

任务来源

Markdown 文件（默认）：

ralphy --prd PRD.md

## Tasks
- [ ] create auth
- [ ] add dashboard
- [x] done task (skipped)

Markdown 文件夹（适用于大型项目）：

ralphy --prd ./prd/

当指向一个文件夹时，Ralphy 会读取所有 .md 文件并聚合任务：

prd/
  backend.md      # - [ ] create user API
  frontend.md     # - [ ] add login page
  infra.md        # - [ ] setup CI/CD

任务按文件进行追踪，因此完成情况会更新到对应的文件中。

YAML:

ralphy --yaml tasks.yaml

tasks:
  - title: create auth
    completed: false
  - title: add dashboard
    completed: false

JSON:

ralphy --json PRD.json

{
  "tasks": [
    {
      "title": "create auth",
      "completed": false,
      "parallel_group": 1,
      "description": "Optional details"
    }
  ]
}

标题必须是唯一的。

GitHub Issues:

ralphy --github owner/repo
ralphy --github owner/repo --github-label "ready"

并行执行

ralphy --parallel                  # 默认 3 个 Agent
ralphy --parallel --max-parallel 5 # 5 个 Agent

每个 Agent 都有隔离的工作树 (worktree) 和分支：

Agent 1 → /tmp/xxx/agent-1 → ralphy/agent-1-create-auth
Agent 2 → /tmp/xxx/agent-2 → ralphy/agent-2-add-dashboard
Agent 3 → /tmp/xxx/agent-3 → ralphy/agent-3-build-api

不使用 --create-pr：自动合并回基础分支，AI 处理冲突。 使用 --create-pr：保留分支，并创建 PR。 使用 --no-merge：保留分支，不进行合并或创建 PR。

YAML 并行组 - 控制执行顺序：

tasks:
  - title: Create User model
    parallel_group: 1
  - title: Create Post model
    parallel_group: 1  # 相同组 = 同时运行
  - title: Add relationships
    parallel_group: 2  # 在第 1 组完成后运行

分支工作流

ralphy --branch-per-task                # 每个任务一个分支
ralphy --branch-per-task --create-pr    # + 创建 PR
ralphy --branch-per-task --draft-pr     # + 创建草稿 PR
ralphy --base-branch main               # 基于 main 分支创建

分支命名：ralphy/