Codex Local
codexlocal runs OpenAI's Codex CLI on the same machine as Paperclip. Use it when you want a local coding agent with persistent session state, managed CODEXHOME, and Paperclip skills injected into the…
Codex Local
codexlocal runs OpenAI's Codex CLI on the same machine as Paperclip. Use it when you want a local coding agent with persistent session state, managed CODEXHOME, and Paperclip skills injected into the Codex skills directory.
---
When To Use
You already use the Codex CLI on the host machine. You want session continuity across heartbeats. You want Paperclip to manage a per-company Codex home when possible. You want repo instructions, Paperclip instructions, and Codex's own runtime behavior to work together.
When Not To Use
The runtime lives behind a webhook or remote API. Use HTTP (/docs/adapters/http). You only need a shell command or script. Use Process (/docs/adapters/process). Codex CLI is not installed or cannot be executed from the Paperclip host.
---
Common Fields
| Field | Required | Notes | |---|---:|---| | cwd | no | Absolute working directory for the agent. Recommended in practice. If omitted, the adapter falls back to the current process working directory. Paperclip creates the path when permissions allow. | | model | no | Codex model id. Common choices include gpt-5.4, gpt-5.3-codex, and o4-mini. | | promptTemplate | no | Prompt template used for the run. | | instructionsFilePath | no | Markdown file prepended to the stdin prompt sent to codex exec. | | modelReasoningEffort | no | Reasoning effort override passed through Codex config. | | search | no | Runs Codex with --search. | | dangerouslyBypassApprovalsAndSandbox | no | Bypasses Codex safety checks for unattended runs. | | command | no | Defaults to codex. | | extraArgs | no | Extra CLI arguments appended to the Codex invocation. | | env | no | Environment variables passed to the runtime. Secret refs are supported. | | timeoutSec | no | Run timeout in seconds. 0 means no timeout. | | graceSec | no | Grace period before a forced stop. | | workspaceStrategy | no | Execution workspace strategy, such as gitworktree. | | workspaceRuntime | no | Reserved workspace runtime metadata. |