mirror of
https://github.com/pocketpaw/pocketpaw.git
synced 2026-05-13 21:21:53 +00:00
57b807c117
Comprehensive SEO optimization across 80 documentation pages: Title optimization (all pages): - Replaced generic titles like "Architecture", "Discord", "Slack" with search-intent titles like "PocketPaw Architecture: Event-Driven Message Bus", "Discord Bot Setup: Add PocketPaw to Your Server" - All titles now 50-70 characters with qualifying keywords Meta descriptions: - Expanded 7 short descriptions (under 145 chars) to 150-160 chars - Roadmap description expanded from 76 to 196 chars - Troubleshooting, Codex CLI, OpenCode, WebMCP all expanded H1 heading fixes: - Ensured single H1 per page matching the frontmatter title - All H1 headings updated to match new optimized titles Internal cross-links: - Added Related CardGroup sections to 60+ individual pages - Each links to 2-3 related pages within and across sections - Channels link to channel guides, backends link to Ollama guide, etc. Em dash cleanup: - Replaced em dashes with colons, periods, or double hyphens across multiple files in tools/, channels/, integrations/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
90 lines
2.6 KiB
Plaintext
90 lines
2.6 KiB
Plaintext
---
|
|
title: "Codex CLI: Code-Focused AI Backend"
|
|
description: "The Codex CLI backend wraps OpenAI's Codex CLI for code-focused agent tasks with MCP server support, NDJSON streaming, and shell/file tools for programming workflows."
|
|
section: Agent Backends
|
|
ogType: article
|
|
keywords: ["codex cli", "openai codex", "code generation", "mcp", "cli wrapper"]
|
|
tags: ["backends", "codex"]
|
|
---
|
|
|
|
# Codex CLI: Code-Focused AI Backend
|
|
|
|
The Codex CLI backend wraps OpenAI's **Codex CLI** as a subprocess, providing code-focused agent capabilities with MCP support.
|
|
|
|
## Overview
|
|
|
|
- **Status**: Beta
|
|
- **Provider support**: OpenAI
|
|
- **Built-in tools**: shell, file_edit, web_search, mcp
|
|
- **MCP support**: Yes
|
|
- **Architecture**: Subprocess wrapper — spawns the `codex` binary
|
|
|
|
## Prerequisites
|
|
|
|
Install the Codex CLI globally:
|
|
|
|
```bash
|
|
npm install -g @openai/codex
|
|
```
|
|
|
|
Verify it's on your PATH:
|
|
|
|
```bash
|
|
codex --version
|
|
```
|
|
|
|
## Configuration
|
|
|
|
```bash
|
|
export POCKETPAW_AGENT_BACKEND="codex_cli"
|
|
export POCKETPAW_OPENAI_API_KEY="sk-..."
|
|
```
|
|
|
|
The backend also accepts `CODEX_API_KEY` as an alternative to `OPENAI_API_KEY`.
|
|
|
|
### Backend-Specific Settings
|
|
|
|
| Setting | Env Variable | Default | Description |
|
|
|---------|-------------|---------|-------------|
|
|
| `codex_cli_model` | `POCKETPAW_CODEX_CLI_MODEL` | `"gpt-5.3-codex"` | Model to use |
|
|
| `codex_cli_max_turns` | `POCKETPAW_CODEX_CLI_MAX_TURNS` | `0` (unlimited) | Max tool-use turns per query |
|
|
|
|
## Built-in Tools
|
|
|
|
| Codex Tool | Policy Mapping |
|
|
|-----------|---------------|
|
|
| `shell` | `shell` |
|
|
| `file_edit` | `write_file` |
|
|
| `web_search` | `browser` |
|
|
| `mcp` | `mcp` |
|
|
|
|
## How It Works
|
|
|
|
1. PocketPaw spawns the `codex` CLI binary as a subprocess
|
|
2. Messages and history are injected via the CLI's input interface
|
|
3. Output streams as NDJSON (newline-delimited JSON)
|
|
4. PocketPaw parses NDJSON events into `AgentEvent` objects
|
|
5. MCP servers are forwarded to the Codex CLI
|
|
|
|
## When to Use
|
|
|
|
Choose Codex CLI when:
|
|
|
|
- You want a code-focused agent optimized for programming tasks
|
|
- You're already using OpenAI's Codex CLI and want it integrated into PocketPaw
|
|
- You need MCP support with an OpenAI-based backend
|
|
|
|
## Related
|
|
|
|
<CardGroup>
|
|
<Card title="OpenAI Agents SDK" icon="lucide:brain" href="/backends/openai-agents">
|
|
Another OpenAI-powered backend with GPT models and Ollama support.
|
|
</Card>
|
|
<Card title="Claude Agent SDK" icon="lucide:sparkles" href="/backends/claude-sdk">
|
|
The recommended backend with native tools and MCP integration.
|
|
</Card>
|
|
<Card title="All Agent Backends" icon="lucide:layers" href="/backends">
|
|
Compare all six backends side by side with capability badges.
|
|
</Card>
|
|
</CardGroup>
|