Codex CLI 使用说明
这份文档基于 OpenAI 官方 Codex CLI 文档整理,只覆盖官方明确文档化的能力。
它是什么
Codex CLI是 OpenAI 的本地 coding agent。- 它可以读取、修改、执行代码,也支持 review、resume、MCP、web search、cloud task。
- 配置文件使用 TOML。
安装
安装
npm i -g @openai/codex
启动
codex
首次运行会要求登录:
- ChatGPT 账号
- 或 API key
升级
npm i -g @openai/codex@latest
常见启动方式
交互模式
codex
直接带 prompt
codex "Explain this codebase to me"
指定模型
codex --model gpt-5.4
图片输入
codex -i screenshot.png "Explain this error"
codex --image img1.png,img2.jpg "Summarize these diagrams"
非交互执行
codex exec "fix the CI failure"
恢复会话
codex resume
codex resume --last
codex resume --all
codex resume <SESSION_ID>
也支持恢复 exec 会话:
codex exec resume --last "Implement the plan"
常用能力
Review
官方文档里,/review 会启动一个独立 reviewer:
- review against base branch
- review uncommitted changes
- review a commit
- custom review instructions
Web search
Codex CLI 默认就有 web search。
可选模式:
cachedlivedisabled
例如:
web_search = "cached"
Cloud task
codex cloud
codex cloud exec --env ENV_ID "Summarize open bugs"
Shell completion
codex completion bash
codex completion zsh
codex completion fish
例如 zsh:
eval "$(codex completion zsh)"
Approval modes
官方文档提到 3 个主要模式:
AutoRead-onlyFull Access
会话内可以用:
/permissions
切换。
常用 slash commands
官方文档明确列出的常用命令包括:
/permissions/agent/apps/clear/compact/copy/diff/experimental/feedback/init/logout/mcp/mention/model/plan/personality/ps/fork/resume/new/review/status/debug-config/statusline/quit/exit
其中最常用的几个:
/model:切模型/personality:切风格/plan:进 plan mode/permissions:切审批策略/compact:压缩上下文/diff:看工作区 diff/review:做本地代码审查/mcp:看当前 MCP 工具/init:生成AGENTS.md
配置文件
配置位置
官方文档说明的主要层级: