DOCS

读懂 Clidex,
再上手更快。

从产品原理到 CLI 命令,从自动换号到余额告警,这里是 Clidex 的完整使用说明。

Clidex 介绍

什么是 Clidex

区别于任何其他中转站,我们并非以统一 API 网关反代 Claude 或 Codex 的中转平台,Clidex 客户端以 Claude 和 Codex 官方订阅账号启动 Pty 交互式终端,提供原生的 CLI 体验。

Clidex 的模型是真实的吗?

Clidex 的全部模型均为官方 CLI 下发模型,所有上架账号均为订阅账号,启动 Clidex 可直观看到所用为订阅模式和账号非 API KEY 调用中转,保障了模型的高可用、高保真性,全部模型均为官方原生模型,源头上杜绝模型掺水。

为什么不做反代

反代意味着要以网关模拟客户端发送请求,必然无法保证请求中包含的指纹信息完全匹配;Clidex 的所有请求均为 Claude 和 Codex 原生 CLI 发送,没有任何指纹匹配风险,同时每个账号分配独立静态 IP 保证使用场景单一,极大程度抑制封号的产生。

快速开始

安装 Clidex

在终端下载安装脚本一键部署:

  • macOS、Linux、WSL

    curl -fsSL https://clidex.dev/install.sh | bash
  • Windows PowerShell

    irm https://clidex.dev/install.ps1 | iex
  • Windows CMD

    curl -fsSL https://clidex.dev/install.cmd -o install.cmd && install.cmd && del install.cmd

如果您看到 The token '&&' is not a valid statement separator,说明您在 PowerShell 中,而不是 CMD。如果您看到 'irm' is not recognized as an internal or external command,说明您在 CMD 中,而不是 PowerShell。当您在 PowerShell 中时,您的提示符显示 PS C:\,当您在 CMD 中时显示 C:\(没有 PS)。

如果安装命令失败并显示 syntax error near unexpected token '<'、403 或其他 curl 错误,请参阅 Troubleshoot installation 以匹配错误并获得修复方案和替代安装方法。

建议在原生 Windows 上安装 Git for Windows,以便 Claude Code 和 Codex 可以使用 Bash 工具。如果未安装 Git for Windows,Claude Code 将使用 PowerShell 作为 shell 工具。WSL 设置不需要 Git for Windows。

连接你的 Clidex 账户

  • 登录 Clidex 控制平台:https://dash.clidex.dev/login
  • 点击 CLI 接入 菜单,复制页面给出的一键配对命令(形如 clidex init https://api.clidex.dev <YOUR_TOKEN>)
  • 打开终端粘贴命令回车,看到 “✔ 配对成功: <你的用户名>” 即连接成功

init 只需要做一次,且当场就会校验 token 是否有效。地址必须是 api. 开头的机器接口地址,不是 dash. 控制台地址——网页给出的命令已经带对,照抄即可。

开始对话

cd 到任意项目目录,直接输入:

clidex

首次在该项目启动时,会提示选择 Claude / Codex,确认后打开对应的原生交互终端。当前目录会自动绑定为工作区;如果已经记住该项目的选择,下次启动会直接使用。

选择 Agent 后,首次使用该类型开会话时,还会询问是否把本机的配置和当前项目的历史会话同步上来,详见下文「同步本机配置与历史会话」。

选择并记住 Agent

在选择界面中,↑ / ↓ 切换 Claude 与 Codex,回车确认,Esc 取消启动。默认勾选“记住此项目的选择”;按空格取消勾选后,每次启动都会询问。

clidex                         # 使用项目已记住的选择,未记住时询问
clidex --choose-agent          # 重新选择,并调整是否记住
clidex --claude                # 仅本次使用 Claude
clidex --codex                 # 仅本次使用 Codex
clidex --choose-agent -w ~/project  # 重新选择指定工作区的 Agent
  • --claude / --codex 只覆盖本次会话,不修改项目已记住的选择;它们与 --choose-agent 三者互斥。
  • 想恢复每次询问,运行 clidex --choose-agent,取消“记住此项目的选择”后确认。
  • 选择按工作区目录分别保存,-w 指定目录时使用该目录的记录。记录保存在本机 ~/.config/clidex/projects/,不会写入项目文件。
  • clidex connect 和 clidex max 使用同样的选择规则;自动换号重连沿用本次已选的 Agent。
  • 在管道、脚本等非交互环境中,会使用已记住的选择;没有记录时需显式指定 --claude 或 --codex。

CLI 命令

命令 作用
clidex / clidex connect 申请执行节点并开启交互式终端(不带子命令时等价于 connect)
clidex max 同 clidex,但只分配 Max 档订阅账号,见下文「优享 Max」
clidex init <平台地址> <token> 一次性配对账号,之后无需再传地址或 token
clidex --load [claude|codex] 勾选本机配置与当前目录的历史会话,上传到平台后退出,默认 Claude
clidex status 查看计费方式、额度使用情况与余额(--json 供脚本消费)
clidex tray 单独启动一个常驻托盘图标(不开会话)
clidex update 检查并升级到最新版本(--check 只查不装)
clidex version 查看版本与构建信息

常用参数:

参数 说明
--claude / --codex 仅为本次会话指定 Agent,不修改项目已记住的选择
--choose-agent 重新选择项目的 Agent 及是否记住,与 --claude / --codex 互斥
-w, --workspace 绑定的项目目录,默认当前目录
--no-tray 开会话时不挂托盘图标
--accel 手动指定加速通道(SSH / HTTP 隧道),网络质量差时使用,见下文「加速通道」
--direct 忽略平台下发的加速通道,强制直连

clidex status 常用组合:

clidex status          # 人类可读
clidex status --json   # 脚本 / 监控消费

clidex tray 常用参数:

clidex tray --display used                    # 百分比按"已用"而非默认的"剩余"展示
clidex tray --interval 60s --low-balance 20    # 轮询间隔与余额告警阈值

-s/--addr、-t/--token 等参数是本地联调直连某个已知节点的逃生口,正常使用不需要传:节点由平台按你的订阅档位自动分配,证书也随会话一起下发。

同步本机配置与历史会话

把本机已经调好的 Claude / Codex 配置和当前项目的历史会话带到 Clidex 上,开会话后就是熟悉的那一套,/resume 也能接着之前的对话聊。

怎么同步

clidex --load          # 同步 Claude 配置与当前目录的历史会话
clidex --load codex    # 同步 Codex 配置与当前目录的历史会话

--load 只上传、不开会话,也不读取或修改项目记住的 Agent。省略类型时仍同步 Claude;同步 Codex 请用 clidex --load codex。它不能与 --choose-agent 同时使用。扫描完会先列出跳过了哪些内容,然后弹出勾选列表:

  • ↑ / ↓ 移动,空格勾选,a 全选,回车确认,Esc 取消
  • 勾选的内容打包上传(带进度条),之后新开的会话自动带上
  • 勾了哪一类就整体替换哪一类:比如勾了 skills,本机删掉的技能,平台上也会跟着删;没勾的类别保持平台上原样
  • 上传途中按 Ctrl+C 即退出,本次上传全部作废,之前同步过的配置不受影响
  • 不在终端里运行(管道、脚本)时不弹列表,全部同步

首次使用每种 Agent 时会主动询问:clidex init 之后第一次使用 Claude 或 Codex 开会话,会先弹出对应的勾选列表问要不要同步,按 Esc 跳过直接开会话。

同步需要账户有余额;余额不足时会提示先充值,首次开会话也不会询问,充值后第一次开会话再问。

同步哪些内容

Agent 同步内容
Claude CLAUDE.md、rules、commands、agents、skills、output-styles、workflows、themes、keybindings.json、settings.json 中的个性设置、当前目录的历史会话
Codex AGENTS.md(含 AGENTS.override.md)、prompts、rules、skills(~/.agents/skills 与 ~/.codex/skills)、当前目录的历史会话

settings.json 个性设置

settings.json 只同步下面这些个性设置,其余字段一律不同步:

字段 作用
theme 终端配色主题
outputStyle 回复的输出风格
language Claude 回复使用的语言
viewMode 对话界面的显示模式
verbose 显示完整的工具调用输出
prefersReducedMotion 减少界面动画
spinnerVerbs 自定义等待时的动态提示词
spinnerTipsEnabled 等待时显示使用小贴士
editorMode 输入框编辑模式(普通 / Vim)
respectGitignore @ 引用文件时不列出 .gitignore 忽略的文件
alwaysThinkingEnabled 默认开启深度思考
showThinkingSummaries 显示思考过程摘要
showTurnDuration 显示每轮回复耗时
timeFormat 时间显示格式
timeZone 时区
attribution Git 提交和 PR 中的署名文字
includeCoAuthoredBy 提交时附带 Co-Authored-By 署名
  • 只在本机的值变了时才更新,你在会话里用 /config 改过的设置不会被改回去
  • 平台不支持的取值(如 custom: 自定义主题)会在扫描摘要里列出并跳过

其他说明

  • 不同步:settings.json 里的 env、hooks、permissions、model 等字段,以及 config.toml、MCP、插件、记忆(memory/)。这些内容可能把会话改到别的 API 地址或执行本机专属的命令,不适合带进云端
  • 技能里的脚本在会话中照常可用
  • 软链会跟随;.git、node_modules 之类目录自动跳过
  • 上限:单文件 1 MB,配置总共 20 MB、最多 2000 个文件,超出的会在扫描摘要里列出

历史会话

  • 只同步当前工作目录的历史会话(当前目录或 -w 指定的目录,子目录里开的会话不算)。其他项目要同步,cd 到那个项目目录再执行一次 clidex --load 或 clidex --load codex;当前目录在本机没有会话记录时,列表里不会出现这一项
  • 同步后在同一个目录下使用对应的 Agent(clidex --claude 或 clidex --codex),用 /resume 就能找回之前的会话接着聊;也可以运行 clidex,确认项目已记住或本次选中了对应的 Agent
  • 导入时会去掉会话里的思考内容:思考内容和生成它的模型、账号绑定,换到平台的账号上校验不过,会导致会话无法续接;去掉后前后消息自动接上,不影响对话内容
  • 平台上已有的同名会话不会被覆盖(你可能已经在平台上续接过);只有本机又接着聊了更多内容时才会更新
  • 上限:单个会话 50 MB,总共 200 MB

优享 Max

余额达到平台门槛的用户,可以指定只使用 Max 档订阅账号开会话:

clidex max             # 使用项目已记住的 Agent,未记住时询问
clidex --claude max    # Claude,只分配 Claude Max 订阅账号
clidex --codex max     # Codex,只分配 ChatGPT Pro(含 Pro Lite)订阅账号
  • 余额门槛:账户余额需不低于平台设定的门槛。余额不足时会拒绝开会话,终端会提示门槛和当前余额;充值后重试,或去掉 max 按普通方式分配
  • 暂无可用 Max 账号时自动降级:会话照常打开、分配普通账号,并在终端提示 当前没有可用的 Max 账号,本次已为您分配普通账号,不会让你开不了会话
  • 自动换号同样优先 Max:会话中账号额度触及阈值、自动换号续接时,仍优先换到 Max 账号,没有可用的 Max 账号才降级
  • 其他参数照常可用,例如 clidex max -w ~/project --no-tray

使用机制

凭证额度触及阈值:自动换号并续接会话

每个账号背后可能绑定了多个上游 AI 凭证。当正在使用的那把凭证用量接近平台设定的阈值时,平台会主动关闭当前会话并要求客户端重新申请一次,整个过程无需手动干预:

  1. 终端会打印提示:当前账号凭证额度不足,正在为你切换账号并续接会话 (第 N/3 次, X 后重试) ...
  2. CLI 沿用本次已选的 Claude / Codex,自动向平台重新申请会话,拿到新的凭证与执行节点
  3. 之前的对话上下文会被续接,不需要重新描述需求
  4. 重试间隔按次数递增(2 秒、4 秒、6 秒),最多自动重连 3 次;仍然失败会给出明确报错,提示手动重新执行 clidex connect
  5. 使用 clidex max 开的会话,换号时同样优先换到 Max 账号

这个机制不需要用户干预,过程中你只会看到终端短暂“卡”一下并打印切换提示。

余额不足 / 无可用账号:拒绝新会话,而不是掐断旧会话

如果余额不足,或执行层暂时未就绪、账号池暂无可分配的节点,平台不会强行打断正在跑的会话,而是在申请新会话时直接拒绝——包括首次 clidex connect,也包括上面提到的自动换号重连。拒绝原因会由平台生成、直接打印在终端上(例如余额不足、暂无可用账号等)。这时需要去控制台充值或联系管理员,而不是等待自动恢复。

托盘:观察以上自动切换的唯一入口

clidex / clidex connect 默认会在菜单栏 / 通知区域挂一枚环形进度图标(--no-tray 可关闭),会话结束自动收起;也可以用 clidex tray 单独常驻。它是余额告警这些“平台不主动播报”的事件在敲代码过程中唯一能看到的地方:

  • 按量付费:图标直接显示余额,低于 --low-balance(默认 $5)转黄,低于其五分之一转红
  • 读不到状态时显示 ?,与“用量为 0”区分开

加速通道与自动更新(附带机制)

  • 网络质量差(跨境、运营商绕路)时,会话可以经 SSH / HTTP 中转机转发底层 TCP,TLS 仍是客户端与执行节点端到端握手,中转机只搬字节、看不到内容;通道连不上会自动回退直连,不会挡在会话之外。
  • clidex connect / status 会在后台每天最多检查一次新版本,有新版会在会话跑着的时候后台下载替换,会话结束后提示一句,下次启动即为新版;设环境变量 CLIDEX_AUTO_UPDATE=0 只提示不自动换,CLIDEX_UPDATE_CHECK=0 连检查都不做。