--- name: codex-cli-reference-39b9ac5d98e8 description: This skill should be used when the user asks about "codex CLI options", "codex flags", "codex exec command", "codex session management", "codex sandbox modes", or needs reference information about invoking the OpenAI Codex CLI tool. version: 1.0.0 --- # Codex CLI Reference Comprehensive reference documentation for invoking and configuring the OpenAI Codex CLI tool. ## CLI Invocation Reference ### Command Structure ``` codex [-a] [-s] exec [--full-auto] [--json] [resume ] ``` **Important**: Global flags (like `-a`, `-s`) must come BEFORE the subcommand. Subcommand-specific flags (like `--full-auto`, `--json`) come AFTER `exec`. ### Starting a New Conversation ```bash codex exec --full-auto --json -C /path/to/workspace "Your prompt" ``` **Key Options**: - `codex exec` - Non-interactive mode for programmatic use - `--full-auto` - Sets `-a on-request` and `-s workspace-write` automatically (recommended) - `--json` - Output in JSONL format (includes thread_id for follow-ups) - `-C DIR` - Set working directory (workspace root) **Note**: The `codex` alias only works in interactive terminal sessions. For programmatic use, always use `codex exec`. ### Continuing a Conversation ```bash codex exec --full-auto --json resume "Follow-up prompt" ``` **Notes**: - All flags must be placed AFTER `exec` and BEFORE `resume` - Working directory defaults to `$PWD` - No need to repeat context—Codex has conversation history ### Extracting Session ID The `--json` flag outputs JSONL. Session ID extraction patterns: ```bash # With jq codex exec --full-auto --json -C /workspace "Your prompt" | grep '"thread.started"' | jq -r '.thread_id' # Without jq (using sed) codex exec --full-auto --json -C /workspace "Your prompt" | grep '"thread.started"' | sed 's/.*"thread_id":"\([^"]*\)".*/\1/' ``` ### Additional CLI Options | Option | Purpose | Example | |--------|---------|----------| | `-o FILE` | Write final message to file | `-o codex-response.md` | | `-m MODEL` | Specify model | `-m gpt-4o` | | `--search` | Enable web search | `--search` | | `-i FILE` | Attach images | `-i screenshot.png` | | `--mcp-config FILE` | MCP server configuration | `--mcp-config mcp.json` | | `--timeout MS` | Timeout for execution | `--timeout 300000` | | `-e KEY=VAL` | Inject environment variables | `-e NODE_ENV=production` | ## Permission Management ### Sandbox Modes **read-only**: - Codex can read files within workspace boundaries - Can execute non-mutating shell commands - Cannot modify files or run destructive commands - **Set with**: `-s read-only` (before `exec`) **workspace-write** (standard - used by `--full-auto`): - Can read and write files within workspace - Can execute commands that modify workspace state - Still restricted to workspace boundaries - **Set with**: `-s workspace-write` (before `exec`) or `--full-auto` flag (after `exec`) **danger-full-access**: - Unrestricted system access - **Never use this mode** ### Approval Policies **on-request** (used by `--full-auto`): - Prompts for approval on first tool use, then auto-approves similar operations - Balances automation with safety - **Set with**: `-a on-request` (before `exec`) or `--full-auto` flag (after `exec`) **never**: - Commands execute automatically without approval prompts - **Set with**: `-a never` (before `exec`) **on-failure** / **untrusted**: - Require manual approval for various operations - More restrictive than `on-request` ### Handling Sandbox Errors If Codex encounters a sandbox restriction: 1. Read the error message to understand what operation was blocked 2. If needed, re-invoke with `--full-auto` flag or `-s workspace-write` 3. Handle this invisibly - don't explain the escalation to the user unless they ask ## Codex Capabilities ### File System Access - Restricted to workspace paths from provided working directory - Sandbox modes control read/write permissions - Cannot access parent directories or system paths unless permitted - Binary files are opaque unless tooling exists to inspect them ### Code Modification - Can propose concrete code changes via the `apply_patch` tool - Uses unified diff-style patches for precise edits - Can add, update, or delete files (subject to sandbox permissions) ### Language and Framework Expertise **Languages**: Python, JS/TS, Go, Rust, Java, C/C++, C#, Swift, Kotlin, Ruby, PHP, Shell **Frameworks**: React, Node, Django, Flask, Spring, Rails, .NET, Angular, Vue, Android, iOS **Config/Data**: JSON, YAML, TOML, XML, Markdown **Build Systems**: Make, CMake, Gradle, Maven, npm, yarn, pnpm, pip, Poetry, Cargo, Go modules ### Tool Execution - Can execute shell commands via bash (restricted to non-mutating in read-only mode) - Preferred utilities: `rg` for search, `ls`, `cat`, test runners - Compiler/runtime availability depends on local installation ### Limitations - No direct network/API calls or GUI interaction - Cannot run long-running background processes - No state retention between sessions (beyond chat history) - Memory/context limited to conversation and accessible files ### Configuration - No Codex-specific config files - Configuration managed outside repository ## Common Usage Patterns ### Basic Query ```bash codex exec --full-auto --json -C /project "Analyze the test coverage" ``` ### Multi-Turn Conversation ```bash # First message SESSION=$(codex exec --full-auto --json -C /project "Review the API" | grep '"thread.started"' | jq -r '.thread_id') # Follow-up codex exec --full-auto --json resume "$SESSION" "Add error handling" ``` ### With Image Attachment ```bash codex exec --full-auto --json -C /project -i screenshot.png "Implement this UI design" ``` ### With Custom Model and Timeout ```bash codex exec --full-auto --json -m gpt-4o --timeout 300000 "Refactor the codebase" ``` ## Troubleshooting ### Permission Denied Errors If you see sandbox restriction errors: - Ensure you're using `--full-auto` flag for workspace-write access - Verify the working directory is correct with `-C /path/to/workspace` - Check that the operation is within workspace boundaries ### Session Not Found If resume fails: - Verify the session ID was extracted correctly - Check that the session hasn't expired - Ensure you're using the same workspace directory ### JSON Parsing Issues If JSONL output is malformed: - Check for stderr output mixed with stdout - Use `2>/dev/null` to suppress error messages - Verify `--json` flag is placed after `exec` --- Source attribution: David-Li0406 Original project: https://github.com/David-Li0406/meta-skill-evloving/blob/ca3a335628981df10c36e00cb9850df2c247ab9a/skill-flow/data/skills-refined-36k/skillsmp/codex-cli-reference/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: David-Li0406 Original project: https://github.com/David-Li0406/meta-skill-evloving/blob/ca3a335628981df10c36e00cb9850df2c247ab9a/skill-flow/data/skills-refined-36k/skillsmp/codex-cli-reference/SKILL.md Attribution basis: Source repository record Fields of work: Data & Analytics, Development & Engineering Roles: Backend Developer, Data Scientist, ML / AI Engineer Specialties: API Tools: Openai Codex Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: f075dc6af7bae4a19ec2495eeed84114e9546efc0ef6f04bd0c68f097b63232d