Skip to content

AI Code UI Documentation

Welcome to the AI Code UI documentation. This guide covers everything you need to know about installing, configuring, and using the application.

What is AI Code UI?

AI Code UI (formerly Claude Code UI) is a full-stack web application providing a unified interface for multiple AI coding assistants:

  • Claude Code - Anthropic's AI coding assistant via SDK
  • Cursor CLI - Cursor's AI-powered code editor CLI
  • OpenAI Codex - OpenAI's code generation model

Getting Started

Document Description
Getting Started Installation and initial setup
CLI Reference Command-line interface usage
Docker Setup Docker deployment and configuration
Configuration Environment variables and settings

Architecture & Development

Document Description
Architecture System architecture overview
Project Structure File and directory reference
Frontend React frontend architecture
Database Database schema and operations

API Documentation

Document Description
API Reference REST API endpoints
WebSocket API Real-time communication protocol

Features & Integrations

Document Description
AI Providers Claude, Cursor, and Codex integration
TaskMaster AI-powered task management integration
MCP Servers Model Context Protocol server configuration

Operations & Security

Document Description
Security Security architecture and best practices
Troubleshooting Common issues and solutions
Contributing How to contribute to the project

Features

Multi-Provider Support

  • Switch between Claude, Cursor, and Codex seamlessly
  • Unified chat interface for all providers
  • Provider-specific model selection
  • Extended thinking modes (Think, Think Hard, Think Harder, Ultrathink)

Project Management

  • Automatic project discovery from ~/.claude/, ~/.cursor/, ~/.codex/
  • Session history and continuation
  • Manual project creation and import with folder browser
  • Delete projects with all associated sessions

Internationalization (i18n)

  • Multi-language support with i18next
  • Currently supported: English, Simplified Chinese (简体中文)
  • Language auto-detection and localStorage persistence
  • Extensible translation system with namespaces

Development Tools

  • Integrated file browser with CodeMirror editor
  • Interactive terminal (PTY) sessions
  • Git panel with staging, commits, and branch management
  • Real-time file watching and updates

TaskMaster Integration

  • AI-powered task management
  • PRD (Product Requirements Document) support
  • Task breakdown and tracking

Security

  • JWT-based authentication
  • Optional API key protection
  • Path traversal prevention
  • SQL injection protection via prepared statements

System Requirements

  • Node.js 20.x or later
  • npm 10.x or later
  • SQLite 3.x (bundled with better-sqlite3)
  • Git (for git operations)

Optional Requirements

  • Docker and Docker Compose for containerized deployment
  • AWS credentials for Bedrock integration
  • Claude CLI for Claude Code integration
  • Cursor CLI for Cursor integration

Support

  • Issues: GitHub Issues
  • Documentation: This docs folder
  • CLAUDE.md: In-repo architecture guide for AI assistants

License

See LICENSE in the project root.