Skip to content

codex.md

Latest commit

 

History

History
58 lines (45 loc) · 2.97 KB

codex.md

File metadata and controls

58 lines (45 loc) · 2.97 KB
Raw

Codex

Control the OpenAI Codex Desktop App headless or headfully via Chrome DevTools Protocol (CDP). Because Codex is built on Electron, OpenCLI can directly drive its internal UI, automate slash commands, and manipulate its AI agent threads.

Prerequisites

  1. You must have the official OpenAI Codex app installed.
  2. Launch it via the terminal and expose the remote debugging port: 
    # macOS
/Applications/Codex.app/Contents/MacOS/Codex --remote-debugging-port=9238

Setup

export OPENCLI_CDP_ENDPOINT="http://127.0.0.1:9238"

Commands

Diagnostics

  • opencli codex status: Checks connection and reads the current active window URL/title.
  • opencli codex dump: Dumps the full UI DOM and Accessibility tree into /tmp.
  • opencli codex screenshot: Captures DOM + snapshot artifacts of the current window.

Agent Manipulation

  • opencli codex new: Simulates Cmd+N to start a completely fresh and isolated Git Worktree thread context.
  • opencli codex send "message": Robustly finds the active Thread Composer and injects your text.
    • Pro-tip: You can trigger internal shortcuts, e.g., opencli codex send "/review".
  • opencli codex ask "message": Send + wait + read in one shot.
  • opencli codex read: Extracts the entire current thread history and AI reasoning logs.
  • opencli codex projects: List visible sidebar projects and conversations.
  • opencli codex history: List visible conversation threads grouped by project.
  • opencli codex extract-diff: Automatically scrapes any visual Patch chunks and Code Diffs.
  • opencli codex model: Get, list, or switch the currently active model / reasoning level.
  • opencli codex export: Export the current conversation as Markdown.

Conversation Management

  • opencli codex pin: Pin the selected conversation and verify the sidebar row becomes pinned.
  • opencli codex unpin: Unpin the selected conversation and verify the sidebar row becomes unpinned.
  • opencli codex archive --yes: Archive the selected conversation after verifying the row disappears. Without --yes, it only returns a dry-run preview.
  • opencli codex rename "New title": Rename the selected conversation and verify the same thread row shows the new title.

Selecting a Project Conversation

send, ask, read, pin, unpin, archive, and rename can select a visible sidebar conversation before acting:

opencli codex projects
opencli codex send "Sync the repo and report blockers" --project stock --conversation "同步各仓库最新代码"
opencli codex ask "Summarize current status" --project opencli --index 2 --timeout 120
opencli codex read --project /Users/youngcan/stock --thread-id local:019df125-bf8b-77f0-ade5-de44670db82d
opencli codex pin --project opencli --index 2
opencli codex rename "Release triage" --thread-id local:019df125-bf8b-77f0-ade5-de44670db82d

Project selection matches either the project label or path. Conversation selection accepts --conversation, --index, or --thread-id.