AliveAI 用户使用教程
Codex CLI 零基础安装与使用
从安装环境、创建 API Key 到第一次在项目中运行 Codex,按下面顺序操作即可。Windows、macOS 和 Linux 都有可直接复制的命令。
- 创建 API Key
- 安装 Node.js
- 安装 Codex CLI
- 保存环境变量
- 创建两个配置文件
- 测试连接
auth.json。
1. 登录并创建 API Key
- 打开 AliveAI 控制台 并登录。
- 在左侧菜单打开令牌管理,也可以直接进入 令牌管理页。
- 点击添加令牌。
- 名称填写“我的电脑-Codex”,其它不确定的选项保持默认。
- 保存后复制新创建的
sk-...令牌。
sk-你的令牌 要替换成真实 Key,但不要把执行后的终端截图发给别人。
2. 安装 Node.js
Codex CLI 通过 npm 安装,所以电脑上要先有 Node.js 和 npm。推荐安装 Node.js LTS 长期支持版。
Windows:PowerShell
- 按
Win + X。 - 打开终端或Windows PowerShell。
- 运行下面的安装命令。
winget install OpenJS.NodeJS.LTS
安装结束后关闭终端并重新打开,然后验证:
node --version
npm --version
两条命令都显示版本号就说明成功。没有 winget 时,请从 Node.js 官网下载 LTS 安装包并保持默认选项。
Windows:可选的 WSL2
刚入门时使用上面的 PowerShell 方式最简单。项目已经放在 Linux 环境中时,可以用管理员 PowerShell 安装 WSL2:
wsl --install
完成后重启电脑,打开 Ubuntu,再按照下面的 Linux 步骤操作。Windows 的 C 盘在 WSL 中通常位于 /mnt/c/。
macOS
打开终端 Terminal。先按 Homebrew 官网说明安装 Homebrew,再运行:
brew install node
node --version
npm --version
Ubuntu / Debian / WSL2
sudo apt update
sudo apt install -y curl
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
sudo apt install -y nodejs
node --version
npm --version
最后两条命令都显示版本号即可继续。
3. 安装 Codex CLI
Windows、macOS 和 Linux 使用同一条官方安装命令:
npm install --global @openai/codex
安装结束后检查版本:
codex --version
看到类似 codex-cli 0.x.x 的版本信息就说明安装成功。
以后更新 Codex
codex update
当前版本不支持自更新时,重新安装最新版:
npm install --global @openai/codex@latest
4. 保存 AliveAI API Key
配置文件只保存环境变量名称,不直接写入真实 Key。把命令中的 sk-你的令牌 替换成第 1 步复制的真实令牌。
Windows PowerShell
[Environment]::SetEnvironmentVariable("ALIVEAI_API_KEY", "sk-你的令牌", "User")
$env:ALIVEAI_API_KEY = "sk-你的令牌"
第一行让以后新开的终端也能读取令牌;第二行让当前窗口立即生效。
macOS(默认 zsh)
echo 'export ALIVEAI_API_KEY="sk-你的令牌"' >> ~/.zshrc
source ~/.zshrc
Linux / WSL2(默认 bash)
echo 'export ALIVEAI_API_KEY="sk-你的令牌"' >> ~/.bashrc
source ~/.bashrc
macOS/Linux 只需要当前终端临时生效时使用:
export ALIVEAI_API_KEY="sk-你的令牌"
5. 创建 Codex 配置
需要创建两个文件。config.toml 定义 AliveAI 接口;aliveai.config.toml 定义模型和推理强度。
Windows:创建两个配置文件
在 PowerShell 中运行:
New-Item -ItemType Directory -Force "$env:USERPROFILE\.codex" | Out-Null
notepad "$env:USERPROFILE\.codex\config.toml"
记事本打开后,粘贴下面内容并按 Ctrl + S:
[model_providers.aliveai]
name = "AliveAI"
base_url = "https://api.aliveai.asia/v1"
env_key = "ALIVEAI_API_KEY"
wire_api = "responses"
关闭记事本,再打开第二个文件:
notepad "$env:USERPROFILE\.codex\aliveai.config.toml"
粘贴并保存:
model_provider = "aliveai"
model = "gpt-5.4"
model_reasoning_effort = "high"
config.toml 和 aliveai.config.toml。使用“另存为”时,将保存类型改成“所有文件”。macOS:创建两个配置文件
mkdir -p ~/.codex
touch ~/.codex/config.toml ~/.codex/aliveai.config.toml
open -e ~/.codex/config.toml
在第一个文件中粘贴:
[model_providers.aliveai]
name = "AliveAI"
base_url = "https://api.aliveai.asia/v1"
env_key = "ALIVEAI_API_KEY"
wire_api = "responses"
保存后打开第二个文件:
open -e ~/.codex/aliveai.config.toml
粘贴并保存:
model_provider = "aliveai"
model = "gpt-5.4"
model_reasoning_effort = "high"
Linux / WSL2:创建两个配置文件
mkdir -p ~/.codex
nano ~/.codex/config.toml
粘贴主配置:
[model_providers.aliveai]
name = "AliveAI"
base_url = "https://api.aliveai.asia/v1"
env_key = "ALIVEAI_API_KEY"
wire_api = "responses"
按 Ctrl + O、Enter 保存,按 Ctrl + X 退出。再运行:
nano ~/.codex/aliveai.config.toml
粘贴下面内容,用相同方式保存:
model_provider = "aliveai"
model = "gpt-5.4"
model_reasoning_effort = "high"
0.134.0 及以上版本使用独立的 aliveai.config.toml。新安装用户不要照旧教程写 [profiles.aliveai],也不要手动修改 auth.json。
6. 测试连接
先执行一个不会修改文件的简单测试:
codex exec --profile aliveai "只回复:连接成功"
终端返回“连接成功”,说明 Node.js、Codex、API 地址、模型和令牌都已配置正确。
7. 在项目中使用 Codex
Codex 会把启动时所在的文件夹当作工作区,所以要先进入项目目录,再启动 Codex。
Windows 示例
cd "D:\Projects\my-app"
codex --profile aliveai
也可以在文件资源管理器中打开项目文件夹,点击地址栏,输入 powershell 并按 Enter,然后运行第二条命令。
macOS / Linux / WSL2 示例
cd ~/Projects/my-app
codex --profile aliveai
进入 Codex 后怎么说
直接输入中文任务并按 Enter。先说明目标、范围和是否允许修改,效果会更稳定。
先阅读这个项目,告诉我它如何启动,不要修改文件。
帮我修复登录按钮点击后没有反应的问题。先定位原因,再修改并运行相关测试。
为刚才修改的功能补充测试,运行测试后汇报结果。
检查当前未提交的改动,重点找功能回归和安全问题,不要修改文件。
推荐操作顺序
- 先让 Codex 阅读项目并说明计划。
- 确认它理解正确后,再让它修改。
- Codex 请求执行命令时,先看清命令和影响范围再批准。
- 修改完成后,让它运行测试或构建。
- 使用
/diff查看改动。 - 重要项目提交 Git 前使用
/review再检查一次。
常用命令
在普通终端中运行
| 命令 | 作用 |
|---|---|
codex --profile aliveai | 使用 AliveAI 启动交互界面 |
codex exec --profile aliveai "任务" | 执行一次任务,完成后退出 |
codex --version | 查看版本 |
codex --help | 查看命令帮助 |
codex doctor | 生成安装和配置诊断 |
codex resume | 继续以前的会话 |
codex update | 更新支持自更新的 Codex 版本 |
进入 Codex 后输入
| 命令 | 作用 |
|---|---|
/status | 查看当前模型、权限和工作目录 |
/model | 查看或切换模型与推理强度 |
/permissions | 切换只读、自动修改等权限 |
/diff | 查看当前代码改动 |
/review | 审查未提交改动或分支差异 |
/new | 在当前项目中新建会话 |
/resume | 恢复以前的会话 |
/quit 或 /exit | 退出 Codex |
任务正在执行时按 Ctrl + C 可以中断。
常见问题排查
提示 node 或 npm 不是命令
Node.js 没安装成功,或者安装后没有重新打开终端。关闭所有终端,重新打开后检查:
node --version
npm --version
仍然失败时重新安装 Node.js LTS。
提示 codex 不是命令
先确认 npm 全局安装位置和 Codex 包:
npm config get prefix
npm list --global @openai/codex
Windows 可以尝试:
codex.cmd --version
如果 codex.cmd 能运行,但 codex 被 PowerShell 的脚本策略拦截,可以设置当前用户范围的执行策略:
Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
关闭并重新打开 PowerShell 后再试。
返回 401、Unauthorized 或 invalid api key
不要输出完整 Key,只检查当前终端是否读取到环境变量。
PowerShell:
if ($env:ALIVEAI_API_KEY) { "已读取 API Key,长度:$($env:ALIVEAI_API_KEY.Length)" } else { "未读取 API Key" }
macOS / Linux:
if [ -n "$ALIVEAI_API_KEY" ]; then echo "已读取 API Key"; else echo "未读取 API Key"; fi
如果未读取,重新执行第 4 步并新开终端。令牌已经泄露时,在控制台删除旧令牌并创建新的。
返回 model not found 或模型不可用
打开控制台查看账户可用模型,把 aliveai.config.toml 中的模型改成实际可用名称,保存后重新启动 Codex:
model = "gpt-5.4"
返回 404、Responses API 或 endpoint 错误
检查 config.toml 中的两项:
base_url = "https://api.aliveai.asia/v1"
wire_api = "responses"
地址末尾要有 /v1,协议是 https,wire_api 是 responses。
修改环境变量后仍使用旧 Key
持久环境变量只会自动进入新开的程序。关闭所有 Codex 和终端窗口,重新打开终端后再测试。
TOML 配置解析失败
- 使用英文半角双引号,不要使用中文引号。
- 每个配置项单独占一行。
- 文件后缀是
.toml,不是.toml.txt。 config.toml中不要保留旧的[profiles.aliveai]。- 运行
codex doctor查看详细诊断。
网络超时或连接中断
先在浏览器打开 AliveAI 控制台。网页也打不开时检查本地网络、代理或防火墙;网页正常但 Codex 仍超时时,稍后重试并保留错误时间和请求 ID。
安全说明
- 只使用控制台“令牌管理”创建的
sk-...令牌。 - 不要把真实令牌直接写进
config.toml。 - 不要手动创建或修改
auth.json,本教程不依赖它。 - 不要发送上游 OAuth JSON、
access_token、refresh_token、服务器密码或管理员凭据。 - 不要把包含密钥的
.codex文件夹提交到 Git。 - 怀疑 Key 泄露时,立即在控制台删除旧 Key 并创建新的。
卸载 Codex CLI
npm uninstall --global @openai/codex
卸载命令不会自动删除 ~/.codex 中的本地配置和历史记录。