FreeLLMAPI CLI完全手册:15个setup命令与launch零持久化启动器
【免费下载链接】freellmapi7.4 billion tokens per month. 34 free LLM providers. 635 free model endpoints. All behind one /v1 endpoint, plus any custom OpenAI-compatible endpoint. Smart routing, automatic failover, encrypted keys. Personal experimentation only.项目地址: https://gitcode.com/GitHub_Trending/fr/freellmapi
FreeLLMAPI 是一个把 34 家免费 LLM 提供商、635 个免费模型端点聚合到单一/v1端点的本地网关,自带智能路由、自动故障切换与加密密钥管理。它的配套 CLI(npx freellmapi)能把 Claude Code、Codex、Aider 等 15 种编码智能体一键接入网关:读取服务器实时模型目录、生成对应配置文件,还提供launch零持久化启动器——凭据只注入子进程内存,全程不落盘。
🚀 快速上手:三步接入第一个编码智能体
前提:Node.js ≥ 20.18,且 FreeLLMAPI 网关已在运行(安装见 docs/install.md)。
第 1 步:获取统一 API 密钥。在仪表盘的 Keys 页面复制你的freellmapi-…统一密钥,这是所有客户端唯一需要的凭据(桌面版用户也可以直接从托盘弹窗获取):
第 2 步:运行 setup 命令。以 Claude Code 为例:
npx freellmapi setup-claude --url http://localhost:3001 --api-key <你的统一密钥>第 3 步:直接启动工具即可。CLI 已自动写入正确的 base URL、模型 ID 与上下文窗口,无需再手动改任何配置。
不想每次输参数?设置环境变量即可被 CLI 自动识别:
export FREELLMAPI_URL=http://localhost:3001 export FREELLMAPI_API_KEY=<你的统一密钥>💡 建议先加
--dry-run预览将要写入的差异,确认无误后再正式执行。
📋 15 个 setup 命令完整清单
npx freellmapi list可随时打印完整清单。每个命令都会拉取网关实时目录(模型 ID、上下文窗口)来生成配置,而不是写死一个模型名:
| setup 命令 | 目标工具 | 写入位置 |
|---|---|---|
setup-claude | Claude Code | ~/.claude/settings.json |
setup-codex | Codex CLI | ~/.codex/config.toml |
setup-claude/launch | Claude Code(零持久化) | 不落盘,仅注入环境变量 |
setup-codex/launch-codex | Codex(零持久化) | 不落盘,仅注入参数与环境 |
setup-cline | Cline | ~/.cline/data/settings/providers.json |
setup-continue | Continue | ~/.continue/config.yaml |
setup-aider | Aider | ~/.aider.conf.yml |
setup-opencode | OpenCode | ~/.config/opencode/opencode.json |
setup-goose | Goose | ~/.config/goose/(provider + config) |
setup-qwen | Qwen Code | ~/.qwen/(settings + .env) |
setup-roo | Roo Code | ~/.roo/freellmapi.json |
setup-kilo | Kilo Code | ~/.config/kilo/kilo.jsonc |
setup-crush | Crush | ~/.config/crush/crush.json |
setup-dsh | DeepSeek Harness | ~/.dsh/settings.yaml+.env |
setup-mimo | MiMo Code | ~/.config/mimocode/config.json |
setup-cursor | Cursor | 不写文件,打印隧道+覆盖配置指南 |
setup-generic | 任意 OpenAI 兼容客户端 | 不写文件,打印环境变量与 curl 示例 |
完整实现见 cli/src/tools.ts,命令说明见 cli/README.md。
⚙️ 常用参数与命名配置
| 参数 | 作用 |
|---|---|
--url URL | 网关地址,默认http://localhost:3000 |
--api-key KEY | 统一 API 密钥(也可用FREELLMAPI_API_KEY环境变量) |
--profile NAME | 生成命名配置,如 Claude/Codex 的多套 profile 并存 |
--model ID | 固定某个模型,而不是用默认的auto智能路由 |
--dry-run | 只打印差异,不写入任何文件 |
例如为一台新机器单独建一套 Claude 配置:
npx freellmapi setup-claude --profile work --model auto命名 profile 会写入~/.claude/profiles/<name>/,用CLAUDE_CONFIG_DIR指向它即可切换,互不干扰。
🔐 launch:零持久化启动器的原理
launch和launch-codex与 setup 系列最大的区别是:凭据从不会写到磁盘上。
npx freellmapi launch # 启动 Claude Code npx freellmapi launch-codex # 启动 Codex CLI工作原理(见 cli/src/index.ts):
- CLI 先向网关
/v1/models拉取实时目录,选定模型(不指定时默认挑一个具体可用模型,让本次会话的模型可见、可复现); - 把
ANTHROPIC_AUTH_TOKEN、base URL、模型 ID 等写进子进程的环境变量,然后以继承 stdio 的方式启动claude/codex; - 进程退出后凭据随之消失,你的 shell 环境、配置文件里什么都不会留下。
同时它会主动清除环境中的真实ANTHROPIC_API_KEY,防止你自己的 Anthropic 密钥被误发给网关。对安全敏感的共享机器场景非常合适。
🛡️ 安全设计:合并而非覆盖,随时可回滚
所有 setup 生成器都是非破坏性的(实现见 cli/src/config-files.ts):
- 结构化合并:只改动自己负责的字段,保留你已有的其他 provider、注释和键序;
- 时间戳备份:写入已存在的文件前,先创建一份带时间戳的备份;
--dry-run差异预览:先看 diff 再落盘;- 敏感文件权限:包含密钥的文件按敏感文件处理。
换句话说,你可以放心反复执行 setup 命令,它幂等且不覆盖。
🩺 doctor:一键诊断"流量到底走没走网关"
最隐蔽的故障是:你改了配置,但工具实际请求根本没到达网关(比如某个环境变量优先级更高,把 base URL 顶掉了)。doctor专门诊断这个问题:
npx freellmapi doctor # 默认检查 claude 和 codex npx freellmapi doctor --timeout 10000它会按每个工具自己的解析规则还原"实际生效的 URL",再探测网关/livez端点,给出明确裁决:routed(已正确路由)、degraded(网关自身不健康)、elsewhere(指向了别的服务)、shadowed(被更高优先级配置掩盖)、unreachable(连不通)。裁决逻辑见 cli/src/doctor.ts。退出码非 0 即有异常,可直接用在脚本里做前置检查。
📚 延伸资料
- CLI 命令与参数速查:cli/README.md
- 各智能体详细接入指南(含 Cursor 隧道、Ollama 兼容、MCP 服务器):docs/clients.md
- 网关安装与部署(Docker / 桌面版 / systemd):docs/install.md
- 免费额度全景:34 家提供商约 74 亿 tokens/月的免费推理容量,详见 README.md
⚡ 小贴士:
auto是网关的虚拟模型,由路由器按速度/能力/可靠度实时挑选最优上游。给长期配置默认写auto,给一次性launch会话固定具体模型,两者搭配使用体验最佳。
【免费下载链接】freellmapi7.4 billion tokens per month. 34 free LLM providers. 635 free model endpoints. All behind one /v1 endpoint, plus any custom OpenAI-compatible endpoint. Smart routing, automatic failover, encrypted keys. Personal experimentation only.项目地址: https://gitcode.com/GitHub_Trending/fr/freellmapi
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考