CLI 使用指南

命令行一键操作 · 支持 AI Agent 全自动接入

点上方按钮复制一份「AI 引导提示」，把它粘贴给任意 AI Agent（ChatGPT / Claude / DeepSeek 等），Agent 就会引导你一步步完成发布免费 Token 信息或获取最新 API Key。内容已结构化，含全部命令与机器可读 --json 输出约定。AI Agent 也可直接抓取纯文本版 /cli-agent.txt 自助接管。

人类友好
一键复制，粘贴即用，无需记忆参数
AI Agent 原生
--json 模式，结构化输入输出
自动鉴权
一次登录，Token 持久保存

安装 CLI

一条命令在本地安装，开箱即连 freeapis.top，无需克隆项目、无需配置（要求 Node ≥ 18）。

# 一键全局安装 CLI
npm install -g https://freeapis.top/download/freeapis-cli-0.20.0.tgz

# 测试连通
freeapis-cli ping

想自己运营一个实例的开发者：git clone 仓库后 npm start，在仓库内用 node cli.js 等价命令（自托管）。

认证

注册或登录后，Token 自动保存到本地，后续命令无需重复登录。

注册（需邀请码）

freeapis-cli register -u 你的用户名 -p 你的密码 -c 邀请码 \
  -e you@mail.com --phone 13800001111   # 邮箱/手机号选填，忘记密码时找回用

邀请码进微信群后向管理员索取，每个码只能用一次。邮箱/手机号选填，但填了才能在忘记密码时自助找回。

登录

freeapis-cli login -u 你的用户名 -p 你的密码

找回密码（无验证码）

凭「用户名 + 注册时填的邮箱/手机号」即可重设密码。未填过联系方式的账号需联系管理员重置。

freeapis-cli recover -u 你的用户名 -e you@mail.com -p 新密码

发布 Token

⚠️ 本站只收录真实可用 Token：--token 与 --url 均必填，纯链接/无 Token 条目一律拒绝。平台会先对 Token 做有效性测试，--url 必须填 API 端点（base_url）（如 https://api.openai.com/v1），测试通过（零错误）才发布。

# 发布真实可用 Token（--url 填 API base_url）
freeapis-cli add \
  --name     "某中转站 GPT-4" \
  --url      "https://x-api.cfd/v1" \
  --provider "X-API" \
  --category "对话模型" \
  --token    "sk-xxx" \
  --token-type "OpenAI" \
  --tags     "GPT-4o,免费"

最简发布（官网链接，无 Token）

freeapis-cli add -n "DeepSeek 免费" -u "https://platform.deepseek.com" -p "DeepSeek" -c "对话模型"

批量导入

freeapis-cli import tokens.json

管理我的发布

查看我的发布

freeapis-cli my

我的统计

freeapis-cli my --stats

编辑条目

freeapis-cli edit <id> \
  --name     "更新后的名称" \
  --url      "https://new-url.com" \
  --provider "新厂商" \
  --category "编程工具"

删除条目

freeapis-cli delete <id>

搜索与浏览

# 列出全部
freeapis-cli list

# 按分类筛选
freeapis-cli list -c "对话模型"

# 关键词搜索
freeapis-cli list -s "免费"
freeapis-cli search "OpenAI"

获取最近发布的 API Key（拉取，每日免费 5 次）

拉取最近发布的 Base URL / API Key / 兼容模式即可调用（需登录）。每日免费拉取 5 次，超出后每次扣 1 积分；发布 Token 即上线可得积分、教程审核通过可得积分，freeapis-cli points 可查余额与明细（版主/管理员豁免）。

freeapis-cli recent

# 指定条数（默认 5，最多 20）
freeapis-cli recent -n 10

# 查看积分余额 / 今日免费额度 / 积分明细
freeapis-cli points

发布 AI 教程

社区共同发布的教程库（/tutorials）。正文为 Markdown 子集：标题 / 段落 / 代码块 / 图片 / 链接 / 加粗斜体 / 列表 / 引用 / 表格 / 分隔线 / 整行 B 站视频链接（自动内嵌播放器）。发布进待审核，版主审核通过后公开。

上传本地图片（封面 / 正文插图共用）

# 上传本地图片 → 返回本站 /uploads/xxx.png 地址（PNG/JPG/WebP/GIF ≤3MB，每日 20 张）
freeapis-cli upload ./封面.png
# → {"ok":true,"data":{"url":"/uploads/xxxx.png","mime":"image/png"}}

# 该地址两种用法：
freeapis-cli tutorial add ... --cover /uploads/xxxx.png   # 作封面
# 正文里写 Markdown 插图（独立成行自动居中大图）：![图片说明](/uploads/xxxx.png)

用 --content 直接传 Markdown

freeapis-cli tutorial add --title "OpenAI API 从零接入" --category OpenAI --tags "入门,教程" --content "# 快速开始

1. 注册并拿到 Key
2. 发起第一次调用"

用 --file 读本地 .md 文件（长文推荐）

freeapis-cli tutorial add --title "我的教程" --file ./guide.md

# 查看 / 搜索 / 我的 / 编辑 / 删除
freeapis-cli tutorial list [-c 分类] [-s 关键词]
freeapis-cli tutorial search <关键词>
freeapis-cli tutorial view <id>
freeapis-cli tutorial my
freeapis-cli tutorial edit <id> --title "新标题" --cover "https://img.example.com/cover.jpg"
freeapis-cli tutorial delete <id>

管理审核 版主/管理员

审核条目需版主/管理员权限；用户管理需管理员权限。先 whoami 查看当前角色。

查看身份 / 用 token 登录

freeapis-cli whoami
freeapis-cli login -t <已有token>
freeapis-cli profile -n "我的昵称"  # 设置昵称（展示名）

条目审核（版主/管理员）

新发布条目自动上线，无需审核；本区块用于管理：失效下线（admin check）、下线不合适的条目、查看存量待审。

# 查看待审核条目
freeapis-cli audit

# 查看已通过 / 全部
freeapis-cli audit --status verified
freeapis-cli audit --status all

# 通过 / 取消验证
freeapis-cli verify <id>
freeapis-cli unverify <id>

用户管理（管理员）

# 列出全部用户
freeapis-cli admin users

# 修改角色
freeapis-cli admin role <id> -r moderator

# 删除用户（及其条目）
freeapis-cli admin delete <id>

# 重置用户密码（新密码至少8位、含字母和数字；用 admin users 查 id）
freeapis-cli admin reset-password <id> <新密码>

# 邀请码：生成 / 查看
freeapis-cli admin invite 5
freeapis-cli admin invites

# 失效检测：一键测试全部已发布条目，明确失效（无效 key/连接失败/404/503）自动下线；429 限流保护视为有效不下架
freeapis-cli admin check

# 教程审核（版主/管理员）：列表 / 通过 / 下线
freeapis-cli admin tutorials --status pending
freeapis-cli admin tutorial-verify <id>
freeapis-cli admin tutorial-unverify <id>

AI Agent 接入 --json

所有命令支持 --json 标志，输出结构化 JSON，AI Agent 可直接解析。

Agent 全自动流程

# 1. 注册（需邀请码，入群后向管理员索取）
freeapis-cli --json register -u bot_001 -p pass123456 -c 邀请码

# 2. 发布
freeapis-cli --json add -n "免费 Token" -u "https://example.com" -p "OpenAI" -c "对话模型"

# 3. 查看
freeapis-cli --json my

# 4. 编辑
freeapis-cli --json edit <id> --name "更新名称"

# 5. 删除
freeapis-cli --json delete <id>

JSON 输出格式

// 注册成功（返回 user 与 token）
{ "ok": true, "data": { "user": { "username": "bot_001", "role": "user" }, "token": "..." } }

// my 命令返回完整数据
{ "ok": true, "data": {
  "items": [{ "id": "...", "name": "...", ... }],
  "stats": { "total": 5, "verified": 2 }
}}

// 失败
{ "ok": false, "error": "用户名已存在" }

远程服务器

# Linux/macOS
export TOKEN_API=https://你的域名
freeapis-cli ping

# Windows CMD
set TOKEN_API=https://你的域名
freeapis-cli ping

其他命令

# 站点统计
freeapis-cli stats

# 测试 Token 有效性（官方端点）
freeapis-cli test-token "sk-xxx" -t "OpenAI"

# 测试自定义厂商端点（中转/聚合 base_url 各不相同）
freeapis-cli test-token "sk-xxx" -t "OpenAI" -u "https://x-api.cfd/v1"
freeapis-cli test-token "sk-xxx" -t "Anthropic" -u "https://api.minimaxi.com/anthropic" -m "MiniMax-M3"

# 帮助
freeapis-cli --help