theia-code-os/packages/ai-codex/README.md

ECLIPSE THEIA - OPENAI CODEX INTEGRATION

---

Description

The @theia/ai-codex integrates OpenAI's Codex agent into the Theia platform, providing natural language coding assistance through the chat interface.

Features

• Natural language coding assistance via OpenAI Codex SDK
• Thread-based conversation management
• Streaming responses with real-time updates
• Token usage tracking and cost monitoring
• Structured output support (JSON Schema, Zod)
• Integration with Theia's AI chat infrastructure

Prerequisites

• Node.js 18 or higher
• OpenAI API key (configured via Theia preferences)

Configuration

API Key

Codex requires an OpenAI API key. You can configure it in several ways (in order of priority):

1. Codex-specific key (highest priority):

   • Preference: ai-features.codex.apiKey
   • Use this if you want a separate API key for Codex

2. Shared OpenAI key (fallback):

   • Preference: ai-features.openAiOfficial.openAiApiKey
   • Shared with other OpenAI integrations in Theia

3. Environment variable (final fallback):

   export OPENAI_API_KEY=your-api-key-here
   

Example

If you already use OpenAI features in Theia, Codex will automatically use that API key. No additional configuration needed!

Additional Information

• API documentation for @theia/ai-codex
• Theia - GitHub
• Theia - Website
• OpenAI Codex SDK

License

• Eclipse Public License 2.0
• 一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception

Trademark

"Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia