yapi-docs

把 YApi 接口 / 项目链接一键转成 Markdown 接口文档（参数、请求体、响应结构），供 AI Agent 直接用作开发上下文，全程命令行完成（包括登录），不打开浏览器。

安装 skill 到你的 Agent

# 交互选择要安装到哪些 Agent（ZCode / Codex(ChatGPT) / Claude Code / Cursor / ~/.agents/skills）
npx -y yapi-docs@latest install --choose

# 装到所有已检测到的 Agent（无参数即此行为，检测不到时默认 ZCode）
npx -y yapi-docs@latest install

# CI / 无终端环境显式指定
npx -y yapi-docs@latest install --agent zcode,claude-code

安装产物只有一个 SKILL.md，运行期命令全部走 npx -y yapi-docs@latest …，目标目录无需 node_modules。

直接使用（不装 skill 也行）

# 单个接口 → stdout 输出 api.md
npx -y yapi-docs@latest https://yapi.xxx.com/project/673/interface/api/63949

# 整个项目 → llms.txt 索引
npx -y yapi-docs@latest https://yapi.xxx.com/project/673 --llms

# 首次 / 登录态过期：浏览器授权（推荐）或账号密码
npx -y yapi-docs@latest auth https://yapi.xxx.com
npx -y yapi-docs@latest login https://yapi.xxx.com --email <邮箱> --password <密码>

认证优先级：--token / YAPI_TOKEN > 已保存登录 Cookie（~/.yapi-agent-docs/cookies.json）> YAPI_COOKIE。要求 Node >= 20。

本地开发

npm install
npm run yapi -- <参数同上>   # 直接跑 TS 源码
npm run build               # esbuild 打包为 dist/cli.js
npm pack                    # 本地出包验证

发布

npm login
npm publish                 # prepack 钩子会自动重新 build