mcpField
A
apidog-cli

apidog-cli

github.com/apidog开发364 次安装16 周前更新
代码仓库

关于 apidog-cli

apidog-cli 是指导 Apidog CLI 操作的技能，强调查询当前命令并在写入前验证架构，适用于需要自动化项目资源并管理分支权限与变更的用户。

主要功能

  1. 01检查当前 CLI 命令和选项
  2. 02查看并验证资源架构
  3. 03管理项目与分支
  4. 04使用隔离的 AI 分支编辑
  5. 05写入前确认权限

适用场景

  1. 01架构验证后创建或更新项目资源
  2. 02查找目标项目或分支
  3. 03在 AI 分支中修改并等待审核
  4. 04依据实时帮助排查 CLI 参数

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/apidog/apidog-cli-skills --skill apidog-cli

安装后在 Claude Code 中输入/apidog-cli确认已加载。

详细介绍

Apidog CLI

使用 Apidog CLI 完成用户的请求。不要凭记忆猜测载荷；优先使用 CLI 的 --help、cli-schema、cli-schema validate 和 agentHints.nextSteps 来决定下一步操作。

新会话检查

  • 首次处理 Apidog CLI 任务时，简单确认 CLI 是否可用：apidog --version、apidog --help。
  • 如果找不到 apidog 或无法输出版本号，请先安装 CLI：npm install -g apidog-cli@latest。
  • 安装后，运行 apidog login --with-token <TOKEN>。从 Apidog 应用或 Web 控制台获取 API 访问令牌：用户头像 → 账户设置 → API 访问令牌。
  • 不要默认每次都升级；仅当命令返回版本过低／未知命令／参数问题（可能由旧版 CLI 导致），或用户的任务依赖新功能时，才建议升级。

基本用法

apidog --help
apidog <command> --help
apidog <command> <subcommand> --help

常见全局选项：

--project <projectId>     Project ID
--branch <branchName>     Branch name; pure numeric values are compatible with legacy branchId
--access-token <token>    Override current login token
--api-base-url <url>      Private deployment URL

登录和项目

  • 如果尚未登录，请向用户索要 API 访问令牌，并运行：apidog login --with-token <TOKEN>。
  • Apidog CLI 令牌存储在 ~/.apidog/config.toml；不要在日志中打印令牌、将其提交到代码库，或在聊天摘要中包含令牌。
  • 如果用户未指定项目，请先检查当前工作区中是否存在 .apidog/settings.json。如果其中包含常用的默认 projectId，优先使用该项目。
  • 建议用户从“项目设置 - 基本设置 - 项目 ID”获取项目 ID；或者先运行 apidog project list，再请用户确认命令要操作的目标项目。
  • 写入任何本地配置文件前，请先征求用户同意。

写入工作流

必需：运行 create 或 update 前，先获取完整的资源定义和数据格式，然后运行 cli-schema validate，再执行实际写入：

  1. 获取架构：apidog cli-schema get <schemaKey>
  2. 生成 JSON 数据文件。
  3. 验证：apidog cli-schema validate <schemaKey> --file <path>
  4. 只有在 validate 通过后，才运行实际的 create 或 update 命令。

命令输出后，优先读取 JSON 输出中的 agentHints.nextSteps，以继续操作或恢复。

先确认 CLI 事实

  • 具体命令、选项和架构键必须以当前 CLI 输出为准：apidog <command> --help、apidog cli-schema list 和 agentHints.nextSteps。
  • 如果本技能与当前 CLI 输出冲突，请以当前 CLI 输出为准，并更新本技能中的事实说明。

CLI 写入权限说明

  • 如果 AI（CLI 来源）权限阻止写入，除非用户已明确指定偏好，否则不要替用户做选择。询问用户是要启用目标分支的直接编辑权限，还是通过 AI 分支编辑目标分支数据。
  • 要直接编辑主分支、迭代分支或常规分支数据，请用户在 Apidog 客户端 2.8.32+ 中启用直接编辑权限：“项目设置 - 功能设置 - AI 功能设置 - 外部 AI 编辑权限”。
  • 如果用户选择 AI 分支，工作流如下： 第 1 步：创建 AI 分支并指定源分支； 第 2 步：按需将源分支资源导入（选取到）AI 分支； 第 3 步：根据用户请求编辑 AI 分支； 第 4 步：完成后，询问用户是否要创建合并请求或执行合并。
  • 直接通过 CLI 执行合并或创建合并请求时，源分支和目标分支都必须启用直接编辑权限开关。否则，提醒用户为相应的分支类型启用权限开关，或在客户端中手动触发合并。

AI 分支

  • AI 分支是一个隔离分支，供 AI/自动化修改项目资源，避免直接污染源分支。
  • 如果 AI 分支在 24 小时内与其源分支没有差异，将自动归档。
  • AI 分支初始为空，不会自动克隆源资源；编辑或删除现有源资源前，先将其导入 AI 分支。
  • 在 AI 分支中新建的资源无需先导入。
  • AI 分支的更改不会自动写回；完成后，请用户确认是立即合并还是创建合并请求。
  • 如果目标主分支受到保护，优先使用 merge-request；不要直接合并。

必须询问用户

  • 登录令牌、本地配置写入、私有部署 URL。
  • 创建/切换 AI 分支、将源资源导入 AI 分支。
  • 删除、归档、覆盖导入、批量更新等破坏性操作。
  • 是否通过合并 / 合并请求将 AI 分支的更改合并回去。
  • 是否升级 CLI。

故障恢复

问题操作
未登录apidog login --with-token <TOKEN>
未知项目apidog project list
未知参数apidog <command> --help
参数或架构错误先运行 cli-schema get / cli-schema validate
AI 写入被阻止说明 AI 分支 / 权限切换，并让用户选择
私有部署添加 --api-base-url https://your-server

评论

支持 Markdown