OpenCodeUI  by lehhair

Web UI for OpenCode backend, powered by AI development

Created 3 months ago
423 stars

Top 69.1% on SourcePulse

GitHubView on GitHub
Project Summary

A third-party web UI for the OpenCode AI development environment, OpenCodeUI offers a feature-rich, adaptable frontend. It targets developers seeking a polished interface, built entirely through AI collaboration ("Vibe Coding"), streamlining interaction with OpenCode's capabilities.

How It Works

This project utilizes a React 19 + TypeScript frontend (Vite 7, Tailwind CSS v4) deployed via Docker. Its architecture includes a Gateway, dynamic port routing, and an optional Tauri desktop client. A key differentiator is its development process, entirely AI-driven ("Vibe Coding"). Core features include an AI chat interface with Shiki code highlighting, an xterm.js terminal (WebGL), file browsing/diffing, and PWA support.

Quick Start & Requirements

  • Primary Install/Run:
    • Hosted: Access https://lehhair.github.io/OpenCodeUI/ after running opencode serve --cors "https://lehhair.github.io" locally.
    • Docker (Standalone UI): Clone repo, cd OpenCodeUI, docker compose -f docker-compose.standalone.yml up -d. Access http://localhost:3000.
    • Docker (Full Stack): Clone repo, configure .env with LLM API keys, docker compose up -d. Access http://localhost:6658.
    • Local Dev: Requires running OpenCode backend, then npm install && npm run dev. Access http://localhost:5173.
  • Prerequisites: Running OpenCode backend, LLM API Keys (OpenAI, Anthropic), Docker, Node.js/npm.
  • Links: Hosted Demo

Highlighted Details

  • AI-Driven Development: Entirely developed using AI assistance ("Vibe Coding").
  • Rich Chat Interface: Message streams, Markdown rendering, Shiki code highlighting.
  • Integrated Web Terminal: xterm.js with WebGL rendering.
  • File Operations: Workspace file browsing and multi-file diff comparison.
  • PWA & Desktop App: Supports PWA installation and includes a Tauri native client (macOS/Linux/Windows).
  • Docker Deployment: Containerized services with automatic discovery and preview link generation.
  • Theming: 3 built-in themes, dark/light modes, custom CSS support.
  • Mobile Adaptability: Optimized for touch and responsive layouts.

Maintenance & Community

Developed entirely via AI assistance ("Vibe Coding"). No specific community links (Discord/Slack) or contributor details were provided in the README snippet.

Licensing & Compatibility

  • License: GNU General Public License v3.0 (GPL-3.0).
  • Compatibility: GPL-3.0 is a strong copyleft license, requiring derivative works to be open-sourced under the same license. This may impose restrictions on integration with proprietary or closed-source software.

Limitations & Caveats

The project is in an early stage and may contain bugs or exhibit instability. It requires a separate, running OpenCode backend instance. The GPL-3.0 license necessitates careful consideration for commercial or closed-source integrations.

Health Check
Last Commit

2 days ago

Responsiveness

Inactive

Pull Requests (30d)
10
Issues (30d)
19
Star History
61 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.