diff --git a/CLI-CREATOR.md b/CLI-EXPLORER.md similarity index 99% rename from CLI-CREATOR.md rename to CLI-EXPLORER.md index 4e16768..73191ed 100644 --- a/CLI-CREATOR.md +++ b/CLI-EXPLORER.md @@ -1,4 +1,4 @@ -# CLI-CREATOR — 适配器开发完全指南 +# CLI-EXPLORER — 适配器探索式开发完全指南 > 本文档教你(或 AI Agent)如何为 OpenCLI 添加一个新网站的命令。 > 从零到发布,覆盖 API 发现、方案选择、适配器编写、测试验证全流程。 diff --git a/CLI-ONESHOT.md b/CLI-ONESHOT.md index 232e563..bc2f71b 100644 --- a/CLI-ONESHOT.md +++ b/CLI-ONESHOT.md @@ -1,7 +1,7 @@ # CLI-ONESHOT — 单点快速 CLI 生成 > 给一个 URL + 一句话描述,4 步生成一个 CLI 命令。 -> 完整探索式开发请看 [CLI-CREATOR.md](./CLI-CREATOR.md)。 +> 完整探索式开发请看 [CLI-EXPLORER.md](./CLI-EXPLORER.md)。 --- @@ -213,4 +213,4 @@ opencli mysite mycommand --limit 3 -v # 实际运行 ## 就这样,没了 -写完文件 → build → run → 提交。有问题再看 [CLI-CREATOR.md](./CLI-CREATOR.md)。 +写完文件 → build → run → 提交。有问题再看 [CLI-EXPLORER.md](./CLI-EXPLORER.md)。 diff --git a/README.md b/README.md index 64d9273..077ca2b 100644 --- a/README.md +++ b/README.md @@ -159,8 +159,9 @@ opencli bilibili hot -v # Verbose: show pipeline debug steps If you are an AI assistant tasked with creating a new command adapter for `opencli`, please follow the AI Agent workflow below: -> **Information for AI:** -> Before writing any adapter code, you **must** read [CLI-CREATOR.md](./CLI-CREATOR.md). It contains the complete browser exploration workflow, the 5-tier authentication strategy decision tree, and debugging guide. Skipping this will lead to preventable errors. +> **Quick mode**: To generate a single command for a specific page URL, see [CLI-ONESHOT.md](./CLI-ONESHOT.md) — just a URL + one-line goal, 4 steps done. + +> **Full mode**: Before writing any adapter code, read [CLI-EXPLORER.md](./CLI-EXPLORER.md). It contains the complete browser exploration workflow, the 5-tier authentication strategy decision tree, and debugging guide. ```bash # 1. Deep Explore — discover APIs, infer capabilities, detect framework diff --git a/README.zh-CN.md b/README.zh-CN.md index 094c7c2..4d2cdd7 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -159,8 +159,9 @@ opencli bilibili hot -v # 详细模式:展示管线执行步骤调试 如果你是一个被要求查阅代码并编写新 `opencli` 适配器的 AI,请遵守以下工作流。 -> **给 AI 的提示:** -> 在编写任何新代码前,你**必须首先阅读 [CLI-CREATOR.md](./CLI-CREATOR.md)**。它包含了完整的适配器开发指南、API 探测流程、5级认证策略以及常见陷阱。如果你跳过这一步直接写代码,会导致很多不必要的错误。 +> **快速模式**:只想为某个页面快速生成一个命令?看 [CLI-ONESHOT.md](./CLI-ONESHOT.md) — 给一个 URL + 一句话描述,4 步搞定。 + +> **完整模式**:在编写任何新代码前,先阅读 [CLI-EXPLORER.md](./CLI-EXPLORER.md)。它包含完整的适配器探索开发指南、API 探测流程、5级认证策略以及常见陷阱。 ```bash # 1. Deep Explore — 网络拦截 → 响应分析 → 能力推理 → 框架检测 diff --git a/SKILL.md b/SKILL.md index 7e15733..b493acb 100644 --- a/SKILL.md +++ b/SKILL.md @@ -11,7 +11,7 @@ tags: [cli, browser, web, mcp, playwright, bilibili, zhihu, twitter, github, v2e > Make any website your CLI. Reuse Chrome login, zero risk, AI-powered discovery. > [!CAUTION] -> **AI Agent 必读:创建或修改任何适配器之前,你必须先阅读 [CLI-CREATOR.md](./CLI-CREATOR.md)!** +> **AI Agent 必读:创建或修改任何适配器之前,你必须先阅读 [CLI-EXPLORER.md](./CLI-EXPLORER.md)!** > 该文档包含完整的 API 发现工作流(必须使用 Playwright MCP Bridge 浏览器探索)、5 级认证策略决策树、平台 SDK 速查表、`tap` 步骤调试流程、分页 API 模板、级联请求模式、以及常见陷阱。 > **本文件(SKILL.md)仅提供命令参考和简化模板,不足以正确开发适配器。** @@ -188,7 +188,7 @@ opencli bilibili hot -v # Show each pipeline step and data flow > 只需要一个 URL + 一句话描述,4 步搞定。 > [!IMPORTANT] -> **完整模式 — 在写任何代码之前,先阅读 [CLI-CREATOR.md](./CLI-CREATOR.md)。** +> **完整模式 — 在写任何代码之前,先阅读 [CLI-EXPLORER.md](./CLI-EXPLORER.md)。** > 它包含:① AI Agent 浏览器探索工作流(必须用 Playwright MCP 抓包验证 API)② 认证策略决策树 ③ 平台 SDK(如 Bilibili 的 `apiGet`/`fetchJson`)④ YAML vs TS 选择指南 ⑤ `tap` 步骤调试方法 ⑥ 级联请求模板 ⑦ 常见陷阱表。 > **下方仅为简化模板参考,直接使用极易踩坑。**