SuperAPI AI 工具集

cli

编程与开发

查看项目

更新于 10-15 21:40

技能介绍

@farming-labs/docs CLI 是 Farming Labs 文档体系的命令行工具,用于在项目中初始化、维护和校验文档及智能体相关产物。

用途与主要能力:脚手架生成文档应用或 Agent Skill;对 Farming Labs 包进行升级或降级;部署 Docs Cloud、配置 MCP、同步 Typesense 或 Algolia 搜索;评审文档改动、审计站点与智能体就绪度;生成或校验 sitemap、Agent Bundle、AGENTS.md、robots.txt 等静态输出;规划与校验文档中的可运行代码块。

用法:一次性命令可用包管理器运行器,如 npx @farming-labs/docs@latest <command>、pnpm dlx @farming-labs/docs@latest <command>、yarn dlx @farming-labs/docs@latest <command>、bunx @farming-labs/docs@latest <command>。已安装项目中用本地版本,如 pnpm exec docs <command>,配置敏感的校验与生成优先用本地二进制。常用命令包括 init、upgrade --dry-run、docs review --ci、docs doctor --agent、docs skills scaffold --dry-run、docs agent export --check、docs sitemap generate --check。选择规则:新文档应用用 init;monorepo 改包前先 upgrade --dry-run;downgrade --version 只用于较低版本,upgrade --version 用于较新版本;变更文档用 docs review,整站就绪度用 docs doctor --agent;生成后用对应 --check 校验;执行可运行文档示例前用 codeblocks validate --plan;stdio 用本地 docs mcp,托管 HTTP 用 mcp setup --deployment。

限制与安全:不要在错误目录或无关应用执行 init;用户仅要求解释或审计时不要执行部署、同步、安装、升级、降级或写文件;密钥应保存在环境变量中;--force 视为破坏性操作,使用前检查已有受管文件;docs doctor command health 为静态检查,可执行示例需显式配置代码块校验。写入后检查 git diff,脚手架或改包后运行类型检查/构建,生成后运行对应 --check。框架识别错误时在应用包根目录传 --framework。具体收费、价格与平台支持信息暂未提供。