Skip to content

Future-Insight/claudecodeui

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

185 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Claude Code UI

Claude Code UI - 中文版

🚀 版本 100.1.0 - 中文化增强版

这是 Claude Code UI 的中文优化版本,基于原项目进行了大幅改进和本地化。

✨ 主要改进 (相对于原版本)

  • 🌏 完整中文界面: 所有界面元素、提示信息、错误消息均已本地化
  • 📝 中文变更日志: 完整的中文更新记录和版本管理系统
  • 🔧 自动化工具: 集成变更日志自动生成和版本管理脚本
  • 💬 中文交互: 优化了用户交互体验,更符合中文用户习惯
  • 🎯 增强功能: 改进会话管理、消息显示和界面布局
  • 📱 移动优化: 针对中文内容优化了移动端显示效果

🎨 界面本地化特性

  • GitPanel 和 SetupForm 组件完全中文化
  • 会话管理界面中文提示和状态显示
  • 错误处理和通知消息本地化
  • 中文友好的布局和排版优化

A desktop and mobile UI for Claude Code, and Cursor CLI. You can use it locally or remotely to view your active projects and sessions in Claude Code or Cursor and make changes to them from everywhere (mobile or desktop). This gives you a proper interface that works everywhere. Supports models including Claude Sonnet 4, Opus 4.1, and GPT-5

Screenshots

Desktop View

Desktop Interface
Main interface showing project overview and chat

Mobile Experience

Mobile Interface
Responsive mobile design with touch navigation

CLI Selection

CLI Selection
Select between Claude Code and Cursor CLI

Features

  • Responsive Design - Works seamlessly across desktop, tablet, and mobile so you can also use Claude Code from mobile
  • Interactive Chat Interface - Built-in chat interface for seamless communication with Claude Code or Cursor
  • Integrated Shell Terminal - Direct access to Claude Code or Cursor CLI through built-in shell functionality
  • File Explorer - Interactive file tree with syntax highlighting and live editing
  • Git Explorer - View, stage and commit your changes. You can also switch branches
  • Session Management - Resume conversations, manage multiple sessions, and track history
  • Model Compatibility - Works with Claude Sonnet 4, Opus 4.1, and GPT-5

Quick Start

Prerequisites

Installation

  1. Clone the repository:
git clone https://github.com/siteboon/claudecodeui.git
cd claudecodeui
  1. Install dependencies:
npm install
  1. Configure environment:
cp .env.example .env
# Edit .env with your preferred settings
  1. Start the application:
# Development mode (with hot reload)
npm run dev

The application will start at the port you specified in your .env

  1. Open your browser:
    • Development: http://localhost:3001

Security & Tools Configuration

🔒 Important Notice: All Claude Code tools are disabled by default. This prevents potentially harmful operations from running automatically.

Enabling Tools

To use Claude Code's full functionality, you'll need to manually enable tools:

  1. Open Tools Settings - Click the gear icon in the sidebar
  2. Enable Selectively - Turn on only the tools you need
  3. Apply Settings - Your preferences are saved locally

Tools Settings Modal Tools Settings interface - enable only what you need

Recommended approach: Start with basic tools enabled and add more as needed. You can always adjust these settings later.

Usage Guide

Core Features

Project Management

The UI automatically discovers Claude Code projects from ~/.claude/projects/ and provides:

  • Visual Project Browser - All available projects with metadata and session counts
  • Project Actions - Rename, delete, and organize projects
  • Smart Navigation - Quick access to recent projects and sessions
  • MCP support - Add your own MCP servers through the UI

Chat Interface

  • Use responsive chat or Claude Code/Cursor CLI - You can either use the adapted chat interface or use the shell button to connect to your selected CLI.
  • Real-time Communication - Stream responses from Claude with WebSocket connection
  • Session Management - Resume previous conversations or start fresh sessions
  • Message History - Complete conversation history with timestamps and metadata
  • Multi-format Support - Text, code blocks, and file references

File Explorer & Editor

  • Interactive File Tree - Browse project structure with expand/collapse navigation
  • Live File Editing - Read, modify, and save files directly in the interface
  • Syntax Highlighting - Support for multiple programming languages
  • File Operations - Create, rename, delete files and directories

Git Explorer

Session Management

  • Session Persistence - All conversations automatically saved
  • Session Organization - Group sessions by project and timestamp
  • Session Actions - Rename, delete, and export conversation history
  • Cross-device Sync - Access sessions from any device

Mobile App

  • Responsive Design - Optimized for all screen sizes
  • Touch-friendly Interface - Swipe gestures and touch navigation
  • Mobile Navigation - Bottom tab bar for easy thumb navigation
  • Adaptive Layout - Collapsible sidebar and smart content prioritization
  • Add shortcut to Home Screen - Add a shortcut to your home screen and the app will behave like a PWA

Architecture

System Overview

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Frontend      │    │   Backend       │    │  Claude CLI     │
│   (React/Vite)  │◄──►│ (Express/WS)    │◄──►│  Integration    │
└─────────────────┘    └─────────────────┘    └─────────────────┘

Backend (Node.js + Express)

  • Express Server - RESTful API with static file serving
  • WebSocket Server - Communication for chats and project refresh
  • CLI Integration (Claude Code / Cursor) - Process spawning and management
  • Session Management - JSONL parsing and conversation persistence
  • File System API - Exposing file browser for projects

Frontend (React + Vite)

  • React 18 - Modern component architecture with hooks
  • CodeMirror - Advanced code editor with syntax highlighting

Contributing

We welcome contributions! Please follow these guidelines:

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone <your-fork-url>
  3. Install dependencies: npm install
  4. Create a feature branch: git checkout -b feature/amazing-feature

Development Process

  1. Make your changes following the existing code style
  2. Test thoroughly - ensure all features work correctly
  3. Run quality checks: npm run lint && npm run format
  4. Commit with descriptive messages following Conventional Commits
  5. Push to your branch: git push origin feature/amazing-feature
  6. Submit a Pull Request with:
    • Clear description of changes
    • Screenshots for UI changes
    • Test results if applicable

What to Contribute

  • Bug fixes - Help us improve stability
  • New features - Enhance functionality (discuss in issues first)
  • Documentation - Improve guides and API docs
  • UI/UX improvements - Better user experience
  • Performance optimizations - Make it faster

更新日志

项目所有重要更改记录在 CHANGELOG.md 文件中。

自动生成变更日志

我们使用自动化工具来维护更新日志:

# 生成/更新变更日志
npm run changelog

# 使用约定式提交格式生成
npm run changelog:conventional

推荐的提交格式

为了更好地自动生成变更日志,请使用以下提交格式:

feat: 添加新功能      # 新增功能
fix: 修复bug         # 错误修复  
refactor: 重构代码   # 代码重构
style: 样式调整      # 样式修改
docs: 文档更新       # 文档变更
test: 测试相关       # 测试代码
chore: 其他维护      # 构建过程或辅助工具的变动

故障排除

常见问题及解决方案

"No Claude projects found"

Problem: The UI shows no projects or empty project list Solutions:

  • Ensure Claude CLI is properly installed
  • Run claude command in at least one project directory to initialize
  • Verify ~/.claude/projects/ directory exists and has proper permissions d

File Explorer Issues

Problem: Files not loading, permission errors, empty directories Solutions:

  • Check project directory permissions (ls -la in terminal)
  • Verify the project path exists and is accessible
  • Review server console logs for detailed error messages
  • Ensure you're not trying to access system directories outside project scope

License

GNU General Public License v3.0 - see LICENSE file for details.

This project is open source and free to use, modify, and distribute under the GPL v3 license.

Acknowledgments

Built With

Support & Community

Stay Updated

  • Star this repository to show support
  • Watch for updates and new releases
  • Follow the project for announcements

Sponsors


Made with care for the Claude Code community.

About

Use Claude Code on mobile and web with Claude Code UI. Claude Code UI free open source webui/GUI that helps you manage your Claude Code session and projects remotely

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 95.7%
  • CSS 2.9%
  • Other 1.4%