{{tag>[cli ai agent openai codex]}}
====== codex ======
OpenAI Codex CLI. Terminal에서 repository를 분석하고 code 작성·수정, command 실행, review, MCP 및 plugin workflow를 수행한다.
===== Summary =====
* ''codex''를 인자 없이 실행하면 interactive TUI를 시작한다.
* ''codex exec''는 non-interactive 실행, ''codex review''는 변경사항 code review에 사용한다.
* 이 페이지는 로컬 ''codex-cli 0.144.5'' help와 2026-07-19 기준 공식 Codex manual의 installer, authentication, update 문서를 반영했다.
===== Installation =====
standalone installer는 ''codex'' 실행 파일을 macOS/Linux에서 기본 ''~/.local/bin''에 설치한다. 원격 설치 스크립트를 실행하기 전에 URL이 공식 ''chatgpt.com'' 도메인인지 확인한다.
# macOS / Linux / WSL: standalone installer
curl -fsSL https://chatgpt.com/codex/install.sh | sh
# npm
npm install --global @openai/codex
# 설치 확인
codex --version
codex doctor
# Windows PowerShell: standalone installer
irm https://chatgpt.com/codex/install.ps1 | iex
# 설치 확인
codex --version
codex doctor
* standalone installer 기본 경로: macOS/Linux ''~/.local/bin'', Windows ''%LOCALAPPDATA%\Programs\OpenAI\Codex\bin''.
* 설치 경로 변경: installer 실행 전에 ''CODEX_INSTALL_DIR''을 지정한다.
* 설치 후 ''codex login''으로 ChatGPT browser login을 진행한다.
* API key 로그인은 secret을 command argument에 직접 쓰지 말고 ''printenv OPENAI_API_KEY | codex login --with-api-key''처럼 stdin으로 전달한다.
* 인증 상태 확인: ''codex login status''. 로그아웃: ''codex logout''.
* self-update를 지원하는 release는 ''codex update''를 사용한다. npm 설치를 명시적으로 갱신하려면 ''npm install --global @openai/codex@latest''를 실행한다.
===== CLI =====
codex
codex "이 저장소 구조를 설명해줘"
codex exec "테스트를 실행하고 실패 원인을 요약해줘"
codex review --uncommitted
codex resume --last
codex doctor
* ''**codex** [OPTIONS] [PROMPT]'': interactive TUI 시작
* ''**codex** exec [OPTIONS] PROMPT'': non-interactive 실행
* ''**codex** review [OPTIONS]'': code review 실행
* ''**codex** login'': ChatGPT 또는 API key 인증
* ''**codex** resume --last'': 최근 session 재개
* ''**codex** mcp'': MCP server 관리
* ''**codex** plugin'': plugin 및 marketplace 관리
* ''**codex** update'': 지원되는 설치에서 CLI update
* ''**codex** doctor'': 설치, config, auth, runtime 진단
===== Options =====
* ''**-m**'', ''**--model** MODEL'': session model override
* ''**-s**'', ''**--sandbox** read-only|workspace-write|danger-full-access'': command sandbox policy
* ''**-a**'', ''**--ask-for-approval** untrusted|on-request|never'': approval policy
* ''**-C**'', ''**--cd** DIR'': working root 지정
* ''**--add-dir** DIR'': 추가 writable directory 지정
* ''**--search**'': live web search 활성화
* ''**--dangerously-bypass-approvals-and-sandbox**'': approval과 sandbox를 모두 우회한다. 외부에서 강하게 격리된 환경 외에는 사용하지 않는다.
===== Command =====
* Session: ''/new'', ''/resume'', ''/fork'', ''/compact'', ''/status''
* Model/behavior: ''/model'', ''/plan'', ''/permissions''
* Project/context: ''/init'', ''/mention'', ''/diff''
* Integration: ''/mcp'', ''/plugins'', ''/skills''
* Help/exit: ''/help'', ''/quit''
===== Shortcut =====
* Enter: prompt 전송 또는 실행 중인 Codex에 추가 지시
* Esc: 현재 작업 중단 또는 dialog 닫기
* ''@FILE'': 파일을 prompt context에 추가
===== Config =====
* 사용자 설정: ''~/.codex/config.toml'' 또는 ''$CODEX_HOME/config.toml''
* repository 설정: ''.codex/config.toml''
* 지속적인 repository 지침: ''AGENTS.md''
* 상태, auth, session 기본 root: ''~/.codex'' 또는 ''CODEX_HOME''
===== Troubleshooting =====
* ''codex: command not found''가 나오면 새 terminal을 열고 standalone install directory 또는 npm global bin directory가 ''PATH''에 있는지 확인한다.
* 설치·auth·runtime 문제가 있으면 ''codex doctor''를 실행한다.
* browser login이 어려운 headless 환경에서는 ''codex login --device-auth''를 검토한다.
* 현재 인증 방식은 ''codex login status''로 확인한다.
===== Help =====
++++ codex --help (codex-cli 0.144.5) |
Usage: codex [OPTIONS] [PROMPT]
codex [OPTIONS] [ARGS]
Primary commands:
exec, review, login, logout, mcp, plugin, mcp-server,
completion, update, doctor, sandbox, apply, resume,
archive, delete, unarchive, fork, cloud, features
Primary options:
-c, --config
-i, --image ...
-m, --model
-p, --profile
-s, --sandbox
-C, --cd
-a, --ask-for-approval
--add-dir
--search
-h, --help
-V, --version
++++
===== See Also =====
* [[claude:ko|Claude Code]]
* [[gemini:ko|Gemini CLI]]
* [[https://learn.chatgpt.com/docs/codex/cli|Official Codex CLI documentation]]
===== History =====
* codex:: 2026-07-19 Migrated the incomplete npm stub to ''codex:ko'' and added official installation, authentication, update, CLI, command, shortcut, config, and troubleshooting coverage.
{{indexmenu>.#1|js}}