apifox-clilisted
Install: claude install-skill codingSamss/all-my-ai-needs
# Apifox CLI
用 Apifox CLI 完成用户请求;不要凭记忆拼 payload,优先让 CLI 的 `--help`、`cli-schema`、`cli-schema validate`、`agentHints.nextSteps` 驱动下一步。
## 新会话检查
- 首次处理 Apifox CLI 任务时,先轻量确认 CLI 可用:`apifox --version`、`apifox --help`。
- 如果 `apifox` 不存在或无法输出版本,先安装 CLI:`npm i -g apifox-cli@latest --registry=https://registry.npmmirror.com/`。
- 安装后执行 `apifox login --with-token <TOKEN>` 登录。API 访问令牌可在 Apifox 客户端或网页端「用户头像 → 账号设置 → API 访问令牌」创建。
- 不要每次默认升级;只有命令返回版本过低/unknown command/参数缺失疑似旧版导致,或用户任务依赖新能力时,才建议升级。
## 基础用法
```bash
apifox --help
apifox <command> --help
apifox <command> <subcommand> --help
```
常用全局参数:
```text
--project <projectId> 项目 ID
--branch <branchName> 分支名;纯数字值兼容旧 branchId
--access-token <token> 覆盖当前登录 token
--api-base-url <url> 私有部署地址
```
## 登录与项目
- 未登录时让用户提供 API 访问令牌,执行:`apifox login --with-token <TOKEN>`。
- Apifox CLI 的鉴权凭证存在 `~/.apifox/config.toml`;不要把 token 打印到日志、提交到仓库或写进普通聊天摘要。
- 如果用户未指定项目,先查看当前工作区是否存在 `.apifox/settings.json`;如其中有常用默认 `projectId`,优先使用该项目。
- 项目 ID 可推荐用户从「项目设置 - 基本设置 - 项目 ID」获取;或先执行 `apifox project list`,给用户确认需执行命令的目标项目。
- 写入任何本地配置文件前先询问用户。
## 写入标准流程
强制:执行 `create` 或 `update` 命令前必须先获取完整的资源定义和数据格式,并在正式执行前通过 `cli-schema validate` 校验写入准确,具体流程:
1. 查对应资源执行命令的 JSON schema:`apifox cli-schema get <schemaKey>`
2. 生成资源的 JSON 数据文件。
3. 校验:`apifox cli-schema validate <schemaKey> --file <path>`
4. 只有 `validate` 无误后,才执行真实 `create` 或 `update` 命令。
命令输出结果后,优先读取 JSON 输出里的 `agentHints.nextSteps` 继续执行或恢复。
## CLI 事实优先
- 具体命令、参数、schema key 以当前 CLI 输出为准:`apifox