-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Add a separate exec doc #4583
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+106
−46
Merged
Add a separate exec doc #4583
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
## Non-interactive mode | ||
|
||
Use Codex in non-interactive mode to automate common workflows. | ||
|
||
```shell | ||
codex exec "count the total number of lines of code in this project" | ||
``` | ||
|
||
In non-interactive mode, Codex does not ask for command or edit approvals. By default it runs in `read-only` mode, so it cannot edit files or run commands that require network access. | ||
|
||
Use `codex exec --full-auto` to allow file edits. Use `codex exec --sandbox danger-full-access` to allow edits and networked commands. | ||
|
||
|
||
### JSON output mode | ||
|
||
`codex exec` supports a `--json` mode that streams events to stdout as JSON Lines (JSONL) while the agent runs. | ||
|
||
Supported event types: | ||
- `thread.started` - when a thread is started or resumed. | ||
- `turn.started` - when a turn starts. A turn encompasses all events between the user message and the assistant response. | ||
- `turn.completed` - when a turn completes; includes token usage. | ||
- `turn.failed` - when a turn fails; includes error details. | ||
- `item.started`/`item.updated`/`item.completed` - when a thread item is added/updated/completed. | ||
|
||
Supported item types: | ||
- `assistant_message` - assistant message. | ||
- `reasoning` - a summary of the assistant's thinking. | ||
- `command_execution` - assistant executing a command. | ||
- `file_change` - assistant making file changes. | ||
- `mcp_tool_call` - assistant calling an MCP tool. | ||
- `web_search` - assistant performing a web search. | ||
|
||
Typically, an `assistant_message` is added at the end of the turn. | ||
|
||
Sample output: | ||
```jsonl | ||
{"type":"thread.started","thread_id":"0199a213-81c0-7800-8aa1-bbab2a035a53"} | ||
{"type":"turn.started"} | ||
{"type":"item.completed","item":{"id":"item_0","item_type":"reasoning","text":"**Searching for README files**"}} | ||
{"type":"item.started","item":{"id":"item_1","item_type":"command_execution","command":"bash -lc ls","aggregated_output":"","status":"in_progress"}} | ||
{"type":"item.completed","item":{"id":"item_1","item_type":"command_execution","command":"bash -lc ls","aggregated_output":"2025-09-11\nAGENTS.md\nCHANGELOG.md\ncliff.toml\ncodex-cli\ncodex-rs\ndocs\nexamples\nflake.lock\nflake.nix\nLICENSE\nnode_modules\nNOTICE\npackage.json\npnpm-lock.yaml\npnpm-workspace.yaml\nPNPM.md\nREADME.md\nscripts\nsdk\ntmp\n","exit_code":0,"status":"completed"}} | ||
{"type":"item.completed","item":{"id":"item_2","item_type":"reasoning","text":"**Checking repository root for README**"}} | ||
{"type":"item.completed","item":{"id":"item_3","item_type":"assistant_message","text":"Yep — there’s a `README.md` in the repository root."}} | ||
{"type":"turn.completed","usage":{"input_tokens":24763,"cached_input_tokens":24448,"output_tokens":122}} | ||
``` | ||
|
||
### Structured output | ||
|
||
By default, the agent responds with natural language. Use `--output-schema` to provide a JSON Schema that defines the expected JSON output. | ||
|
||
The JSON Schema must follow the [strict schema rules](https://platform.openai.com/docs/guides/structured-outputs). | ||
|
||
Sample schema: | ||
|
||
```json | ||
{ | ||
"type": "object", | ||
"properties": { | ||
"project_name": { "type": "string" }, | ||
"programming_languages": { "type": "array", "items": { "type": "string" } } | ||
}, | ||
"required": ["project_name", "programming_languages"], | ||
"additionalProperties": false | ||
} | ||
``` | ||
|
||
```shell | ||
codex exec "Extract details of the project" --output-schema ~/schema.json | ||
... | ||
|
||
{"project_name":"Codex CLI","programming_languages":["Rust","TypeScript","Shell"]} | ||
``` | ||
|
||
Combine `--output-schema` with `-o` to only print the final JSON output. You can also pass a file path to `-o` to save the JSON output to a file. | ||
|
||
### Git repository requirement | ||
|
||
Codex requires a Git repository to avoid destructive changes. To disable this check, use `codex exec --skip-git-repo-check`. | ||
pakrym-oai marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
### Resuming non-interactive sessions | ||
|
||
Resume a previous non-interactive session with `codex exec resume <SESSION_ID>` or `codex exec resume --last`. This preserves conversation context so you can ask follow-up questions or give new tasks to the agent. | ||
|
||
```shell | ||
codex exec "Review the change, look for use-after-free issues" | ||
codex exec resume --last "Fix use-after-free issues" | ||
``` | ||
|
||
Only the conversation context is preserved; you must still provide flags to customize Codex behavior. | ||
|
||
```shell | ||
codex exec --model gpt-5-codex --json "Review the change, look for use-after-free issues" | ||
codex exec --model gpt-5 --json resume --last "Fix use-after-free issues" | ||
``` | ||
|
||
## Authentication | ||
|
||
By default, `codex exec` will use the same authentication method as Codex CLI and VSCode extension. You can override the api key by setting the `CODEX_API_KEY` environment variable. | ||
|
||
```shell | ||
CODEX_API_KEY=your-api-key-here codex exec "Fix merge conflict" | ||
``` | ||
|
||
NOTE: `CODEX_API_KEY` is only supported in `codex exec`. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like we have been moving away from the
--full-auto
name, though I admit it is succinct. No good suggestions here.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should also mention
--skip-git-repo-check
somewhere?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's below
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the lack of better alternative let's stick to full-auto although I agree it's confusing.