paperclip/docs/adapters/codex-local.md at 1fcc6900ffc83e02bbef589a8af689702a15ff10

Files

Dotta 09d2ef1a37 fix: restore docs deleted in v0.2.3 release, add Paperclip branding

- Restored docs/ directory that was accidentally deleted by `git add -A`
  in the v0.2.3 release script
- Replaced generic "P" favicon with actual paperclip icon using brand
  primary color (#2563EB)
- Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark)
- Updated docs.json with logo configuration for dark/light mode
- Fixed release.sh to stage only release-related files instead of `git add -A`
  to prevent sweeping unrelated changes into release commits

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-03-03 15:49:43 -06:00

1.7 KiB

Raw Blame History

title, summary

title	summary
Codex Local	OpenAI Codex local adapter setup and configuration

The codex_local adapter runs OpenAI's Codex CLI locally. It supports session persistence via previous_response_id chaining and skills injection through the global Codex skills directory.

Prerequisites

Codex CLI installed (codex command available)
OPENAI_API_KEY set in the environment or agent config

Configuration Fields

Field	Type	Required	Description
`cwd`	string	Yes	Working directory for the agent process (absolute path; created automatically if missing when permissions allow)
`model`	string	No	Model to use
`promptTemplate`	string	No	Prompt used for all runs
`env`	object	No	Environment variables (supports secret refs)
`timeoutSec`	number	No	Process timeout (0 = no timeout)
`graceSec`	number	No	Grace period before force-kill
`dangerouslyBypassApprovalsAndSandbox`	boolean	No	Skip safety checks (dev only)

Session Persistence

Codex uses previous_response_id for session continuity. The adapter serializes and restores this across heartbeats, allowing the agent to maintain conversation context.

Skills Injection

The adapter symlinks Paperclip skills into the global Codex skills directory (~/.codex/skills). Existing user skills are not overwritten.

Environment Test

The environment test checks:

Codex CLI is installed and accessible
Working directory is absolute and available (auto-created if missing and permitted)
Authentication signal (OPENAI_API_KEY presence)
A live hello probe (codex exec --json - with prompt Respond with hello.) to verify the CLI can actually run

1.7 KiB Raw Blame History