rush-ai

v0.21.0

Published

16 days ago

Rush CLI - Command-line interface for the Rush AI platform

0High
0Medium
0Low

octopus-fe-bot

rush ai cli agent mcp

rush-ai

把本地 IDE 的上下文交给 Rush 的 AI 平台继续执行 —— 不是复述 prompt，是接力。

它解决什么

你在 Cursor / Claude Code 里和本地 agent 聊得正深入 —— 它知道代码库、约束、已经试过什么。当某一步要交给 Rush 平台的云端 agent（建个真实可访问的站、调一个专家 agent、让模型在干净环境里写一套代码），你不想把整个对话再重新组织一遍。

rush-ai 就是这个"接力"动作。本地 agent 调一条 rush-ai task create 把手里有的上下文直接递过去，Rush 接手执行，你切到浏览器看 preview，继续在那边迭代。

# 本地 agent（Cursor / Claude Code / ...）内部跑：
npx rush-ai task create -a web-builder -p "做一个公司官网，大气风格，深色强调色"
# → 拿到 task id，几十秒后 Rush 给回 preview URL

三条主路径

1. 从 prompt 直接建站（`web-builder`）

一句话生成一个完整可访问的站，自带 preview URL。继续迭代用 task send，满意了用 task deploy 上生产。

rush-ai task create -a web-builder -p "做个极简番茄钟 SPA，深色 + emerald 强调色"
# → Task xz5xgpn45fg1 running

rush-ai task status xz5xgpn45fg1
#   Preview:  https://xz5xgpn45fg1-preview.rush.zhenguanyu.com/

rush-ai task send xz5xgpn45fg1 -p "再加一个已完成次数的历史记录"

rush-ai task domain check my-pomodoro --task xz5xgpn45fg1
rush-ai task deploy xz5xgpn45fg1 --domain my-pomodoro --yes
# → https://my-pomodoro.rush.zhenguanyu.com

2. 调用 Rush 的专家 agent 做子任务

Rush 平台有一批领域专家 agent（人力分析、营销策划、数据分析…）。你的 workflow 里某一步需要它们时，不重新写 prompt，直接调。

rush-ai agent list                     # 看看都有谁
rush-ai agent info 人力资源分析专家      # 看这个 agent 的技能和能力
rush-ai task create -a 人力资源分析专家 -p "分析 Q1 部门人效趋势"
rush-ai task result <id> --json        # 拿结构化输出

3. 本地改完代码同步到 Rush

在本地 IDE 里改了几行代码（或本地 agent 改的），想让 Rush 的 preview 立刻反映出来 —— 一条命令：

# 前提：当前目录是 Rush 项目的 checkout
cd my-rush-project
# ... 本地改代码 + commit ...
rush-ai task push

task push 会自动把改动推到 Rush，preview URL 几秒后就会显示新版本。

管理项目环境变量

按 preview / production 分环境给项目配置环境变量（值加密存储、运行时注入，不写进代码仓库）：

# 交互式输入（不回显、不进 shell history），默认 preview
rush-ai task env set OPENAI_API_KEY

# 直接给值 / 指定 production
rush-ai task env set OPENAI_API_KEY sk-xxx --env production

# 从 stdin 读（CI 友好）
echo -n "$SECRET" | rush-ai task env set OPENAI_API_KEY --env production

# 查看（不传 --env 列全部两环境，值脱敏）
rush-ai task env list
rush-ai task env list --env production

# 删除
rush-ai task env rm OPENAI_API_KEY --env production

当前目录是 Rush 项目时自动识别项目，否则用 --project <id> 指定。

Quick Start

要求：Node.js >= 18。如果不想全局装，任何 rush-ai 命令都可以用 npx rush-ai 替代。

# 1. 装 CLI
npm install -g rush-ai

# 2. 登录（浏览器完成）
rush-ai auth login

# 3. 看 agent 列表
rush-ai agent list

# 4. 开一个任务
rush-ai task create -a web-builder -p "做一个极简 todo list"
rush-ai task status <id> --json

rush 是默认的通用 agent，任何 agent list 里的 agent 名字都能作为 -a 的值。

主要能力

任务生命周期：task create / send / status / watch（实时流）/ result / files / cancel
本地同步：task push —— 改完本地代码，Rush preview 立刻更新
生产发布：task deploy <id> —— web-builder 产物发 prod，支持自定义域名
环境变量：task env list/set/rm —— 按 preview/production 管理项目环境变量（加密存储、运行时注入）
agent shelf：agent list / agent info —— 浏览和使用 Rush 平台的专家 agent
MCP 集成：作为 MCP stdio server 跑，或浏览平台上的 MCP server 和工具
Skill 管理：skill install/list/publish 代理 reskill，但复用 Rush 登录态和 registry
多环境 profile：在不同 Rush 环境之间切换
shell 补全：bash / zsh / fish
CI 友好：--json 输出、--ci 模式、出错返回非 0 退出码
插件分发：marketplace + plugin install 一条命令把 Rush 生态的 skill / command / rule / MCP 默认装到 Claude Code、Codex、Cursor；Claude-3p 作为显式 target 用 --target claude-3p 安装；首次 plugin install --target codex 自动把 marketplace 完整目录镜像到 Codex 桌面端 Plugins 页（含未装的插件，无需先 marketplace add）

命令一览

任务流

| 命令 | 说明 | |------|------| | task create | 建一个任务给某个 agent 执行 | | task send <id> | 在已有任务上继续对话 / 发新消息（附件请用 --file） | | task status <id> | 查任务状态 | | task watch <id> | 实时跟一个任务的执行流 | | task result <id> | 拿任务结果 + 文件摘要 | | task files <id> | 列 / 下载任务产出文件 | | task messages <id> | 看任务的对话历史 | | task list / task ls | 列出我的任务 | | task cancel <id> | 取消运行中的任务 | | task push | 同步本地改动到 Rush（当前目录需要是 Rush 项目的 checkout） | | task link | 把现有本地项目接入 Rush，附带 Supabase DB / OSS 上传（--db / --oss） | | task deploy <id> | 发布 web-builder 产物到 prod（--domain / --version / --env） | | task versions <id> | 列出 web-builder 任务的可发布版本 | | task domain check <prefix> | 校验自定义域名前缀是否可用（需 --task <id>） | | task env list | 列出项目环境变量（脱敏）；--env preview\|production 过滤，默认全部 | | task env set <KEY> [value] | 新增/更新环境变量；默认 preview，值可省（走 stdin / 交互式输入） | | task env rm <KEY> | 删除环境变量（--env，默认 preview） |

命名迁移事实：0.10.0 起 task init 改名为 task link（对齐 vercel link / netlify link 语义）；task init 作为 deprecated alias 在 0.13.0 移除。
task link 产生的项目 template = null，目前还不能走 task deploy 自定义域名发布（待 epic #1096 Phase 2）。需要自定义域名时请走 task create -a web-builder。

agent / MCP

| 命令 | 说明 | |------|------| | agent list / agent ls | 列出可用 agent | | agent info <name> | 查某个 agent 的描述、技能、MCP 配置 | | mcp list / mcp ls | 列出 MCP server | | mcp list-tools <id> | 列 MCP server 提供的工具 | | mcp install <id> | 从 Registry 安装 MCP 到 Claude Desktop / Claude Code | | mcp uninstall <id> | 从 Claude Desktop / Claude Code 移除 MCP | | mcp serve | 把 rush-ai 当成 MCP stdio server 启动 |

Skill 管理

| 命令 | 说明 | |------|------| | skill find <query> / skill search <query> | 在 Skill Registry 中搜索 Skill | | skill install [skills...] / skill i | 安装一个或多个 Skill，默认使用当前 Rush registry 和 auth token | | skill list / skill ls | 列出已安装 Skill | | skill info <skill> | 查看 Skill 详情 | | skill update [skill] / skill up | 更新 Skill | | skill outdated | 检查过期 Skill | | skill uninstall <skill> / skill rm | 移除 Skill | | skill publish [path] / skill pub | 发布 Skill 到 Rush Registry | | skill group ... | 管理 Skill 分组和成员 |

rush-ai skill 内置调用 reskill 包管理能力，但用户只需要安装 rush-ai 一个包。执行时会自动把当前 Rush profile 的 API URL 注入为 RESKILL_REGISTRY，并把 rush-ai auth 的 token 注入为 RESKILL_TOKEN。因此 Rush 用户不需要单独安装 reskill 或执行 reskill login：

rush-ai auth login
rush-ai skill install @kanyun/rush-find-skills
RUSH_API_KEY=$KEY rush-ai skill publish --ci --dry-run

Auth 生命周期统一使用 rush-ai auth login/status/logout。如果你要连接非 Rush registry，仍然可以直接使用独立的 reskill CLI。

插件分发

| 命令 | 说明 | |------|------| | marketplace add <source> | 注册 marketplace（github:owner/repo、directory:/abs/path、rush://<host>），同时把 catalog 镜像到 Codex 桌面端 | | marketplace sync [<n>] | 增量刷新 marketplace 镜像；--all 全部刷；--target codex 指定目标 | | marketplace list / remove / update | 管理本地 marketplace 缓存；remove 同步清掉 Codex 端注册和镜像 | | plugin install <ref> | 默认同步装到 Claude Code + Codex + Cursor；--target 可指定单个或多个目标，Claude-3p 需显式 --target claude-3p；--dry-run / --force / --secret KEY=VALUE | | plugin list / uninstall / update | 对称管理 |

<ref> 格式：<name> 或 <name>@<marketplace>（例 my-plugin@rush）。

rush:// source 特性：

首次 plugin install xxx@rush 自动注册 Rush 平台 marketplace（无需手动 marketplace add）
自动从 API 获取 plugin manifest + 用 reskill 下载完整 skill 目录
--secret KEY=VALUE（可重复）预设 MCP 凭证，跳过交互式输入
--force 重新拉取 manifest 并更新 secrets

@rush 中的 Claude 官方镜像特性：

Claude Code 官方 marketplace 镜像也统一使用 @rush 后缀；旧 @claude-plugins-official 后缀已废弃，CLI 会提示改用 @rush
支持 URL source 按需 clone：外部 git repo 的 plugin 自动 clone 到 ~/.rush/plugin-cache/
支持 git-subdir 模式（一个 repo 内多个 plugin）
--force 重新 clone 最新版本

Codex 桌面端浏览体验

只要做了 marketplace add / marketplace sync / plugin install --target codex 任意一个，Codex 桌面端 Plugins 页就会出现该 marketplace 的完整目录（含未装的插件）—— 不需要先知道 plugin 名字再装。展示形式：

未装插件：列表/详情卡片可见，描述里附完整安装命令；点 "添加" 会弹 toast 失败（避免空壳被错误启用），引导用户走终端安装
已装插件（通过 rush-ai plugin install）：UI 显示 "已安装"，MCP 工具可在对话中直接调用
卸载后：插件回到未装状态，依然在列表里作为重装入口

plugin install 触发的同步发生在装完目标 plugin 之后（仅 --target codex 成功时），把 marketplace 里其它插件也一并镜像为 stub。所以从干净状态直接跑一条 rush-ai plugin install context7@rush --target codex 就能在 Codex Plugins 页同时拿到 225 个 plugin 的完整目录。

认证 / 配置 / 其他

| 命令 | 说明 | |------|------| | auth login / status / logout | 登录（浏览器或 API key） / 看状态 / 登出 | | playbook [name] | 输出给本地 Agent 使用的 markdown playbook（旧 skill hand-off 已迁移） | | config show / set / use / create / delete / list | profile 管理（多环境切换） | | completion install / bash\|zsh\|fish | shell 补全 | | doctor | 环境 / 认证 / 连通性诊断 | | check | 本地项目部署前预检 |

全局选项

| 选项 | 说明 | |------|------| | --json | 输出 JSON（机器可读） | | --ci | CI 模式：JSON 输出 + 不交互 + 严格退出码 | | --verbose / --debug | 详细 / 调试输出 | | --no-color | 禁用颜色 | | -f, --format <type> | 输出格式：table / json / csv |

常见用法

认证

# 浏览器登录
rush-ai auth login

# API key 登录（非交互，适合 CI）
rush-ai auth login --api-key <key>

# 看当前登录态
rush-ai auth status

多环境切换

rush-ai config create prod --api https://rush.example.com
rush-ai config create staging --api https://rush-staging.example.com
rush-ai config use prod
rush-ai config list

插件分发（可选）

把 Rush 平台上创建的 Plugin（Skill + MCP 组合包）一键装到本地 IDE：

# 从 Rush 平台安装（自动注册 marketplace，无需手动 add）
rush-ai plugin install my-plugin@rush
# ✓ Claude Code  (skills + MCP)
# ✓ Codex         (skills + MCP)
# ✓ Cursor        (skills + MCP)

# Claude-3p 第一期不进默认 target，需要显式安装
rush-ai plugin install my-plugin@rush --target claude-3p
# ✓ Claude-3p     (commands + skills + hooks + MCP)

# 带 MCP secrets（CI/非交互模式）
rush-ai plugin install my-plugin@rush --secret SHIMO_TOKEN=xxx --secret API_KEY=yyy

# 只装某一家
rush-ai plugin install my-plugin@rush --target claude-code
rush-ai plugin install my-plugin@rush --target claude-3p

# 更新 secrets / 刷新 skill
rush-ai plugin install my-plugin@rush --force --secret SHIMO_TOKEN=new-value

# 预览不落盘
rush-ai plugin install my-plugin@rush --dry-run

# Anthropic 官方 marketplace 镜像（通过 @rush 统一访问，自动注册）
rush-ai plugin install sentry@rush
rush-ai plugin install aikido@rush --target claude-code

# GitHub marketplace 也支持
rush-ai marketplace add github:kanyun-inc/rush-plugin
rush-ai plugin install rush

Claude Code 侧与原生 plugin 清单互通；Codex、Cursor、Claude-3p 由 rush-ai 写入各自原生/适配目录。后续可用 rush-ai plugin list / rush-ai plugin uninstall / rush-ai plugin update 统一管理；Claude-3p 安装后需新开对话生效。不用这条路径就忽略；日常的 task create / task push 和插件分发完全独立。

MCP 安装

# 列出可用的 MCP server
rush-ai mcp list

# 安装到 Claude Desktop + Claude Code（默认两个都装）
rush-ai mcp install octopus-cli-mcp

# 只装到 Claude Desktop
rush-ai mcp install octopus-cli-mcp --target claude-desktop

# 跳过交互 + JSON 输出
rush-ai mcp install octopus-cli-mcp -y --json

# 传入凭证（适合需要 token 的 MCP，两种写法等价）
rush-ai mcp install bigdata-mcp-server --set refresh_token=xxx groups=basic
rush-ai mcp install bigdata-mcp-server --set refresh_token=xxx --set groups=basic

# 安装未验证的 MCP（需明确确认）
rush-ai mcp install some-mcp --allow-unverified

# 卸载
rush-ai mcp uninstall octopus-cli-mcp

stdio MCP 写入 claude_desktop_config.json；http/sse MCP 写入 configLibrary（managed server，工具自动 allow）。安装后需重启 IDE 生效。

Node runtime / 非交互式调用

在 Node.js 脚本或 CI 中调用时，用 -y 跳过交互，--set 传入凭证，--json 获取结构化输出：

const { execSync } = require('child_process');
const result = JSON.parse(
  execSync(
    'rush-ai mcp install bigdata-mcp-server -y --set refresh_token=xxx groups=basic --target claude-desktop --json'
  ).toString()
);

if (result.targets[0].status === 'ok') {
  console.log('Installed to:', result.targets[0].configPath);
}

未验证的 MCP 在非交互模式下需要加 --allow-unverified，否则会报错退出。

CI / 脚本

# 非交互认证
RUSH_API_KEY=$KEY rush-ai task create -a rush -p "Run tests" --ci

# 机器可读输出
rush-ai task status <id> --json | jq '.status'
rush-ai task result <id> --json | jq -r '.result'

环境变量

| 变量 | 说明 | 默认 | |------|------|------| | RUSH_API_KEY | API key，设了就跳过浏览器登录 | — | | RUSH_API_URL | API base URL 覆盖 | https://rush.zhenguanyu.com | | RUSH_PROFILE | 覆盖 active profile | — | | NO_COLOR | 禁用颜色输出 | — | | DEBUG | 启用调试日志 | — |

配置文件

rush-ai 的状态都在 ~/.rush/：

~/.rush/
├── auth.json           # 认证凭据
├── config.json         # profile / 全局配置
├── marketplaces/       # 已注册 marketplace 的本地缓存
└── plugins/
    └── registry.json   # 已装插件账本

License

MIT

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

rush-ai

它解决什么

三条主路径

1. 从 prompt 直接建站（web-builder）

2. 调用 Rush 的专家 agent 做子任务

3. 本地改完代码同步到 Rush

管理项目环境变量

Quick Start

主要能力

命令一览

任务流

agent / MCP

Skill 管理

插件分发

Codex 桌面端浏览体验

认证 / 配置 / 其他

全局选项

常见用法

认证

多环境切换

插件分发（可选）

MCP 安装

Node runtime / 非交互式调用

CI / 脚本

环境变量

配置文件

License

1. 从 prompt 直接建站（`web-builder`）