| name | codex-research |
| description | Research topics or review code using OpenAI Codex CLI.
Use for: technical research, documentation lookup, code analysis,
or when external AI perspective is needed.
|
| context | fork |
| agent | Explore |
| allowed-tools | Bash |
Codex Research Skill
This skill provides integration with OpenAI Codex CLI for research and code review tasks.
Prerequisites
- Codex CLI installed:
npm install -g @openai/codex
- Authentication (one of):
- Run
codex to complete OAuth authentication, OR
- Set
OPENAI_API_KEY environment variable
Available Scripts
All scripts are located in ${CLAUDE_PLUGIN_ROOT}/scripts/.
1. Check Installation
${CLAUDE_PLUGIN_ROOT}/scripts/check-codex.sh
Verifies Codex CLI is installed and authentication is configured (OAuth or API key).
2. Research Mode (codex exec)
${CLAUDE_PLUGIN_ROOT}/scripts/codex-exec.sh "your research question"
Use for:
- Technical research questions
- Documentation lookup
- Concept explanations
- Best practices inquiry
Example:
${CLAUDE_PLUGIN_ROOT}/scripts/codex-exec.sh "What is dependency injection and when should I use it?"
3. Code Review Mode
${CLAUDE_PLUGIN_ROOT}/scripts/codex-review.sh <target>
Options:
--staged - Review all uncommitted changes (staged + unstaged)<file> - Review specific file (uses codex review <file>)<directory> - Review directory (uses codex review <dir>)
Important: --staged uses codex exec review uncommitted which reviews all uncommitted changes, not just staged files. To review only specific files, use the file/directory target.
Examples:
${CLAUDE_PLUGIN_ROOT}/scripts/codex-review.sh --staged
${CLAUDE_PLUGIN_ROOT}/scripts/codex-review.sh src/main.ts
${CLAUDE_PLUGIN_ROOT}/scripts/codex-review.sh ./lib
Workflow
- First, verify Codex CLI is available using
check-codex.sh
- For research tasks, use
codex-exec.sh with the research prompt
- For code review, use
codex-review.sh with the target
Error Handling
- Timeout: Commands timeout after 120 seconds
- Not installed: Provides installation instructions
- Not authenticated: Prompts to complete OAuth or set OPENAI_API_KEY
Notes
This skill uses context: fork to isolate large outputs from the main conversation context.
