CLI 接入帮助文档

统一整理 CodeX 的安装、配置与会话内常用命令。

概览与前置条件

Windows 10/11 macOS 10.15+ Linux 主流发行版 Node.js 18+

本文聚焦 CodeX CLI。建议先安装 Node.js LTS,并确保终端可访问外网。

  • Node.js 官网:https://nodejs.org
  • API Key 获取入口:https://new.liuq.site/console/token
不同 CLI 通常需要对应分组的 API Key,建议分开创建并单独保存。

Windows 工具推荐

Microsoft Windows Terminal(推荐)

建议在 Windows 上统一使用官方终端管理 PowerShell、CMD、WSL,避免在多个终端间切换导致环境不一致。

安装方式

方式一:Microsoft Store

https://apps.microsoft.com/detail/9N0DX20HK701

方式二:Winget

winget install --id Microsoft.WindowsTerminal -e

Release 页面地址

https://github.com/microsoft/terminal/releases

基础使用

  • 可在顶部标签页快速切换 PowerShell、命令提示符、WSL。
  • 可通过 “+” 新建标签页,并使用分屏功能并行执行命令。
  • 在设置中可调整默认 Shell、字体、主题,并支持 JSON 细粒度配置。
wt
wt -p "PowerShell"
wt -p "Command Prompt"

NewApi 站点使用教程

1. 注册账号

  • 访问 https://new.liuq.site
  • 点击注册入口,填写邮箱、用户名和密码完成注册。
  • 若启用了验证流程,按页面提示完成验证后登录。

2. 登录控制台

登录后进入控制台页面,常用入口通常在顶部用户菜单或侧边栏。

3. 生成 API Key

  • 进入令牌管理页:https://new.liuq.site/console/token
  • 点击“添加令牌”或“创建密钥”。
  • 选择分组、设置名称和额度/有效期后保存。

4. 验证 Key(可选)

curl.exe "https://new.liuq.site/v1/models" -H "Authorization: Bearer YOUR_API_KEY"
请勿在公开仓库、截图或聊天记录中泄露 API Key。

CodeX

1. 安装 CLI

npm install -g @openai/codex@latest
codex --version

2. 准备配置目录

Windows

mkdir %USERPROFILE%/.codex
cd %USERPROFILE%/.codex

macOS / Linux

mkdir -p ~/.codex
cd ~/.codex

3. 配置文件

config.toml

model_provider = "newsite"
model = "gpt-5.3-codex"
model_reasoning_effort = "xhigh"
network_access = "enabled"
disable_response_storage = true

[model_providers.newsite]
name = "OpenAI-Compatible"
base_url = "https://new.liuq.site/v1"
wire_api = "responses"
requires_openai_auth = true

auth.json

{
  "OPENAI_API_KEY": "替换为你的 CodeX Key"
}

4. 启动

mkdir my-codex-project
cd my-codex-project
codex

CodeX 常用命令介绍

下面是 codex 交互会话内的常用斜杠命令。

会话内命令

/new      # 新建会话,开始新的上下文
/compact  # 压缩当前上下文,降低上下文长度
/resume   # 恢复历史会话(通常可选择会话继续)
/help     # 查看当前版本支持的全部命令

使用建议

  • 任务切换时用 /new,避免不同需求相互污染。
  • 长会话出现上下文膨胀时用 /compact,提升稳定性。
  • 中断后优先使用 /resume,减少重复描述背景。
  • /help 输出为准,不同版本命令可能存在差异。
该模块说明的是 Codex 会话内部命令,不是终端安装命令。

常见问题

权限报错

全局安装失败时,Windows 请使用管理员终端;macOS/Linux 可使用 sudo 或改为用户级 npm 目录。

命令找不到

安装后重启终端并检查 PATH,然后执行 node --versionnpm --version、CLI 的 --version 进行确认。

鉴权失败

确认使用了对应工具的 API Key,且 Base URL 已配置为 https://new.liuq.site/v1