rush-ai 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kanyun Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,136 @@
+# rush-ai
+
+Rush CLI — Command-line interface for the Rush AI platform.
+
+## Quick Start
+
+```bash
+pnpm --filter rush-ai build
+pnpm --filter rush-ai test
+```
+
+## Testing Strategy
+
+rush-ai 采用三层测试策略，在不同阶段用最合适的方式验证代码正确性。
+
+### L1: 单元测试（本地，秒级反馈）
+
+验证 CLI 自身逻辑，完全不依赖外部服务。
+
+**覆盖范围：**
+
+- 命令解析（commander 参数、flag、子命令路由）
+- 输出格式化（table / `--json` / `--stream`）
+- 配置管理（`~/.rush/` 读写、token 存取）
+- 错误处理（未认证提示、网络错误、API 错误码映射）
+- stdin 管道输入解析
+
+**技术方案：** vitest，mock HTTP 层（`lib/client.ts`），不启动任何服务。
+
+```bash
+pnpm --filter rush-ai test
+```
+
+### L2: 本地联调测试（本地，秒级反馈）
+
+CLI 对本地运行的 Agent 服务做真实调用，验证请求/响应链路。
+
+**前置条件：**
+
+- `pnpm dev:agent` 运行在 `localhost:4000`（需 `.env.local` 配好凭证）
+- 或 `pnpm dev` 同时启动 web + agent
+
+**覆盖范围：**
+
+- auth 认证流程
+- `agent list` / `agent info` 真实返回
+- `task run` 端到端执行（CLI → API → LLM → 结果）
+- `task create` + `task status` + `task result` 异步链路
+- SSE 流式输出（`task watch`）
+
+**技术方案：** vitest e2e 配置，测试前检查 `localhost` health，不可用则 skip。
+
+```bash
+# 需要先启动 agent
+pnpm dev:agent &
+
+pnpm --filter rush-ai test:e2e
+```
+
+### L3: 冒烟测试（CI / 手动，分钟级）
+
+对真实环境做最终确认，验证完整 CLI 链路：`auth → agent list → task run → task result → task files → task list`。
+
+**触发时机：**
+
+- PR 合入后，CI 构建部署完成
+- 手动触发，指定目标环境
+
+**覆盖范围：**
+
+- 核心 happy path 全链路验证
+- 网络 / 鉴权 / 代理等环境相关的集成验证
+- production build 模式下的 API 行为
+
+```bash
+RUSH_API_BASE_URL=https://rush-test.zhenguanyu.com \
+RUSH_AUTH_TOKEN=$CI_TEST_TOKEN \
+pnpm --filter rush-ai test:smoke
+```
+
+## Scripts
+
+| Script | Description |
+|--------|-------------|
+| `test` | L1 单元测试 |
+| `test:e2e` | L2 本地联调测试 |
+| `test:smoke` | L3 冒烟测试 |
+| `test:all` | L1 + L2 |
+| `test:watch` | 单元测试 watch 模式 |
+| `typecheck` | TypeScript 类型检查 |
+| `build` | 构建 |
+
+## Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `RUSH_API_BASE_URL` | API 目标地址 | `http://localhost:3000` |
+| `RUSH_AUTH_TOKEN` | 认证 token（跳过 CAS 交互登录） | — |
+| `RUSH_TEST_AGENT` | E2E 测试用的 Agent 名称 | `rush` |
+
+## Development Verification Flow
+
+每完成一个命令实现：
+
+```bash
+pnpm --filter rush-ai typecheck     # 类型检查
+pnpm --filter rush-ai test           # L1 单元测试
+pnpm --filter rush-ai build          # 确保能构建
+```
+
+涉及 API 交互改动时（需先启动 dev:agent）：
+
+```bash
+pnpm --filter rush-ai test:e2e       # L2 本地联调
+```
+
+PR 合入后（CI 自动或手动）：
+
+```bash
+pnpm --filter rush-ai test:smoke     # L3 部署冒烟
+```
+
+## Project Structure
+
+```
+packages/rush-ai/
+├── src/
+│   ├── commands/          # CLI commands (agent, auth, mcp, plugin, task)
+│   ├── e2e/               # E2E & smoke test files
+│   ├── output/            # Output formatting (table, json, stream)
+│   └── util/              # Shared utilities (client, config, auth, errors)
+├── vitest.config.ts       # L1 unit test config
+├── vitest.e2e.config.ts   # L2 e2e test config
+├── vitest.smoke.config.ts # L3 smoke test config
+└── package.json
+```