rrskill 0.1.0 → 0.1.2

package/README.md

@@ -1,54 +1,56 @@
-# rrskill-cli
+# rrskill CLI
 
-`rrskill-cli/` 是当前官方 `rrskill` Node/TypeScript CLI 源码目录。
+`rrskill` 用于：
 
-这里的文档现在按职责拆开：
+- 搜索技能
+- 安装技能
+- 查看和升级已安装技能
+- 初始化 `openclaw`
+- 检查并修复宿主状态
 
-- [README.md](./README.md)
-  - 面向使用、安装、开发
-- [ARCHITECTURE.md](./ARCHITECTURE.md)
-  - 面向架构、目录结构、文件目的、边界
-- [PUBLISHING.md](./PUBLISHING.md)
-  - 面向版本管理、打包、npm 发布、发布后 smoke
+## 安装说明
 
-## 1. 包定位
+线上安装说明：
 
-这个目录里的 CLI 当前具备：
+```text
+https://rrskill.ai/install/rrskill.md
+```
 
-- Node runtime
-- TypeScript 主实现
-- npm-only 分发
-- npm-only CLI 升级
-- `bootstrap` 作为宿主接入与修复入口
+安装脚本：
 
-官方同时维护两个 npm 包名：
+```bash
+curl -fsSL https://rrskill.ai/install/install.sh | bash
+```
 
-- `rrskill`
-- `@rrskill/cli`
+如果要让 Agent 帮你安装，可以直接发送：
 
-两个包都暴露同一个终端命令：
+```text
+根据 https://rrskill.ai/install/rrskill.md 安装 rrskill CLI
+```
 
-- `rrskill`
+## 安装方式
 
-## 2. 安装方式
+### 官网安装脚本
 
-### 2.1 直接 npm 安装
+```bash
+curl -fsSL https://rrskill.ai/install/install.sh | bash
+curl -fsSL https://rrskill.ai/install/install.sh | bash -s -- --check --output json
+curl -fsSL https://rrskill.ai/install/install.sh | bash -s -- --dry-run
+```
 
-全局安装：
+### 直接安装
 
 ```bash
 npm install -g rrskill
-rrskill bootstrap --host openclaw
 ```
 
 或：
 
 ```bash
 npm install -g @rrskill/cli
-rrskill bootstrap --host openclaw
 ```
 
-一次性运行：
+### 一次性执行
 
 ```bash
 npx rrskill@latest version
@@ -59,179 +61,31 @@ pnpm dlx rrskill@latest version
 pnpm dlx @rrskill/cli@latest version
 ```
 
-### 2.2 官网在线安装脚本
-
-```bash
-curl -fsSL https://rrskill.ai/install/install.sh | bash
-```
-
-指定宿主：
-
-```bash
-curl -fsSL https://rrskill.ai/install/install.sh | bash -s -- --openclaw
-```
-
-说明：
-
-- `install.sh` 默认走完整初始化流程：检查环境、安装 CLI、执行 bootstrap
-- `openclaw` 支持完整初始化
-- `codex` / `claude-code` 可以通过 `--skip-bootstrap` 完成 CLI 安装，但当前不支持完整宿主修复
-- `install.sh` 现在支持 `--check`、`--dry-run`、`--skip-bootstrap`、`--output json|text`
-
-`install.sh` 的职责只有：
-
-1. 检测系统和 Node/npm
-2. 必要时安装受管 Node
-3. 用 npm 安装 `rrskill`
-4. 调用 `rrskill bootstrap --host <name>`
-
-示例：
-
-```bash
-curl -fsSL https://rrskill.ai/install/install.sh | bash -s -- --check --output json
-curl -fsSL https://rrskill.ai/install/install.sh | bash -s -- --dry-run
-curl -fsSL https://rrskill.ai/install/install.sh | bash -s -- --host codex --skip-bootstrap --output json
-```
-
-另外有一个实现约束：
-
-- `install.sh` 顶部常量需要和 `src/installer/constants.ts` 保持一致
-- 我们现在用“显式顶部配置 + 测试校验”来避免 shell / TS 漂移
-
-## 3. 命令说明
-
-当前已接通的核心命令：
-
-| 命令 | 作用 |
-| --- | --- |
-| `rrskill <slug>` | `install` 简写 |
-| `rrskill install <slug>` | 安装指定 marketplace skill |
-| `rrskill search <query>` | 搜索 registry 中的 skill |
-| `rrskill list` | 查看当前宿主已安装 skill |
-| `rrskill upgrade` | 升级当前宿主已安装的 marketplace skill |
-| `rrskill bootstrap --host <name>` | 安装内置 skill、安装宿主 plugin、修复宿主配置、执行校验 |
-| `rrskill doctor --host <name>` | 检查当前 host 的初始化状态，并返回修复建议或直接执行修复 |
-| `rrskill version` | 输出 CLI 版本信息与升级提示 |
-
-host 参数：
-
-```bash
---host <openclaw|codex|claude-code>
---openclaw
---codex
---claude-code
-```
-
-规则：
-
-- `--host` 是 canonical 参数
-- `--openclaw` / `--codex` / `--claude-code` 是 sugar alias
-- 未传 host 时默认 `openclaw`
-- 非法 host 会直接报错，不再静默回退
-
-示例：
+## 常用命令
 
 ```bash
+rrskill search react
+rrskill install web-search
 rrskill web-search
-rrskill web-search --codex
-rrskill install web-search --host claude-code
-rrskill bootstrap --openclaw
-rrskill doctor --host openclaw
-rrskill doctor --host openclaw --fix
-rrskill search browser automation
-```
-
-输出相关：
-
-```bash
-rrskill search react --output json
+rrskill list
+rrskill upgrade
+rrskill bootstrap --host openclaw
 rrskill doctor --host openclaw --output json
-rrskill search react --json
-```
-
-## 4. 配置说明
-
-默认配置文件：
-
-```text
-~/.rrskill/config.json
-```
-
-也可以通过环境变量覆盖：
-
-```bash
-RRSKILL_CONFIG_PATH=/path/to/config.json
-RRSKILL_HOST=codex
-RRSKILL_SKILLS_SEARCH_URL=https://api.rrskill.ai/skills?page=1&size={limit}&search={query}
-```
-
-当前支持的配置字段：
-
-```json
-{
-  "host": "codex",
-  "state_dir": "/Users/demo/.rrskill",
-  "skills_search_url": "https://api.rrskill.ai/skills?page=1&size={limit}&search={query}&orderBy=downloadCount&order=desc"
-}
+rrskill doctor --host openclaw --fix
+rrskill version
 ```
 
-兼容 key：
-
-- `state_dir` / `stateDir`
-- `skills_search_url` / `skillsSearchUrl`
-
-## 5. 当前宿主支持情况
-
-| 能力 | openclaw | codex | claude-code |
-| --- | --- | --- | --- |
-| `search/install/list/upgrade` | 支持 | 支持 | 支持 |
-| 默认路径推导 | 支持 | 支持 | 支持 |
-| `doctor` 检查 | 支持 | 支持 | 支持 |
-| `doctor --fix` 实际修复 | 支持 | 暂未支持 | 暂未支持 |
-| `bootstrap` 完整成功 | 支持 | 暂未支持 | 暂未支持 |
-| `bootstrap` 内置 skill 落点 | 支持 | 支持 | 支持 |
-| `bootstrap` 宿主 plugin 安装 | 支持 | 暂未实现 | 暂未实现 |
-| `bootstrap` 宿主配置修复 | 支持 | 暂未实现 | 暂未实现 |
-| `install.sh` 完整初始化 | 支持 | 需配合 `--skip-bootstrap` | 需配合 `--skip-bootstrap` |
-
-也就是说：
-
-- `openclaw` 是当前唯一做完整 bootstrap repair 的宿主
-- `codex` / `claude-code` 已经有统一路径模型和 skill 落点
-- 这两个宿主当前推荐用 `doctor` 做检查，用 `search/install/list/upgrade` 完成 CLI 侧操作
-- 它们的 `bootstrap` 目前会明确返回未支持，而不是假成功
-- 后续只需要补它们自己的宿主 plugin/config integration
-
-## 6. 开发
-
-当前 `rrskill-cli/` 是仓库内独立包，不在根 `pnpm-workspace.yaml` 里。
-
-开发时建议直接在目录内执行：
+## host 参数
 
 ```bash
-cd rrskill-cli
-pnpm install --ignore-workspace
-pnpm run test
-pnpm run build
-pnpm run build:packages
+--host <openclaw>
+--openclaw
 ```
 
-## 7. 发布
-
-发布教程现在独立放在：
-
-- [PUBLISHING.md](./PUBLISHING.md)
-
-这里单独拎出去的原因是：
-
-- 使用者不需要看维护者发布细节
-- 发布链路比“安装/使用”更强调步骤顺序和校验
-- 现在 `build:packages` 对默认开发版 `0.0.0-dev` 有保护，发布前必须先改版本号
-
-## 8. 进一步阅读
+## 当前支持
 
-如果你现在关心的是：
+当前只写 `openclaw`：
 
-- 怎么安装和使用：看这份 `README.md`
-- 为什么架构这么设计、每个目录和文件是干什么的：看 [ARCHITECTURE.md](./ARCHITECTURE.md)
-- 怎么发版、具体每一步怎么验证：看 [PUBLISHING.md](./PUBLISHING.md)
+- 支持完整初始化
+- 支持 `bootstrap`
+- 支持 `doctor --fix`