2025-07-24 22:27:13 -06:00
|
|
|
# codex
|
|
|
|
|
|
|
|
|
|
> Natural language code assistant for the terminal, powered by OpenAI.
|
|
|
|
|
> Reads and edits files in your current directory to fulfill requests.
|
2026-06-12 17:51:25 -06:00
|
|
|
> More information: <https://developers.openai.com/codex/cli/reference>.
|
2025-07-24 22:27:13 -06:00
|
|
|
|
|
|
|
|
- Start an interactive Codex session in the current directory:
|
|
|
|
|
|
|
|
|
|
`codex`
|
|
|
|
|
|
|
|
|
|
- Run a single Codex command using a prompt:
|
|
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
`codex "{{prompt}}"`
|
2025-07-24 22:27:13 -06:00
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
- Run a prompt allowing Codex to edit files in the workspace:
|
2025-07-24 22:27:13 -06:00
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
`codex --sandbox workspace-write "{{prompt}}"`
|
2025-07-24 22:27:13 -06:00
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
- Use a specific model:
|
2025-07-24 22:27:13 -06:00
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
`codex {{[-m|--model]}} {{model_name}} "{{prompt}}"`
|
2025-07-24 22:27:13 -06:00
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
- Use a local open source model provider:
|
2025-07-24 22:27:13 -06:00
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
`codex --oss --local-provider {{lmstudio|ollama}} "{{prompt}}"`
|
2025-07-24 22:27:13 -06:00
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
- [Interactive] Display session configuration and token usage:
|
2025-07-24 22:27:13 -06:00
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
`/status`
|
2025-07-24 22:27:13 -06:00
|
|
|
|
|
|
|
|
- Display help:
|
|
|
|
|
|
2026-06-12 17:51:25 -06:00
|
|
|
`codex {{[-h|--help]}}`
|