Skip to content
Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

250 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Agent UI

Agent UI

A desktop and mobile UI for Agent, and Cursor CLI. You can use it locally or remotely to view your active projects and sessions in Agent or Cursor and make changes to them from everywhere (mobile or desktop). This gives you a proper interface that works everywhere. Supports models including Agent 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 Agent and Cursor CLI

Features

  • Responsive Design - Works seamlessly across desktop, tablet, and mobile so you can also use Agent from mobile
  • Interactive Chat Interface - Built-in chat interface for seamless communication with Agent or Cursor
  • Integrated Shell Terminal - Direct access to Agent 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
  • TaskMaster AI Integration (Optional) - Advanced project management with AI-powered task planning, PRD parsing, and workflow automation
  • Model Compatibility - Works with Agent Sonnet 4, Opus 4.1, and GPT-5

Quick Start

Prerequisites

One-click Operation (Recommended)

No installation required, direct operation:

npx @siteboon/claude-code-ui

Your default browser will automatically open the Agent UI interface.

Local Development Installation

  1. Clone the repository:
git clone https://github.com/siteboon/agent-ui.git
cd agent-ui
  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 Agent tools are disabled by default. This prevents potentially harmful operations from running automatically.

Enabling Tools

To use Agent'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.

TaskMaster AI Integration (Optional)

Agent UI supports TaskMaster AI (aka claude-task-master) integration for advanced project management and AI-powered task planning.

It provides

  • AI-powered task generation from PRDs (Product Requirements Documents)
  • Smart task breakdown and dependency management
  • Visual task boards and progress tracking

Setup & Documentation: Visit the TaskMaster AI GitHub repository for installation instructions, configuration guides, and usage examples. After installing it you should be able to enable it from the Settings

Usage Guide

Core Features

Project Management

The UI automatically discovers Agent 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 Agent/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 Agent 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

TaskMaster AI Integration (Optional)

  • Visual Task Board - Kanban-style interface for managing development tasks
  • PRD Parser - Create Product Requirements Documents and parse them into structured tasks
  • Progress Tracking - Real-time status updates and completion tracking

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       β”‚    β”‚  Agent 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 (Agent / 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

Troubleshooting

Common Issues & Solutions

"No Agent projects found"

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

  • Ensure Agent 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

MIT License - see LICENSE file for details.

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

Acknowledgments

Built With

  • Agent - Anthropic's official CLI
  • React - User interface library
  • Vite - Fast build tool and dev server
  • Tailwind CSS - Utility-first CSS framework
  • CodeMirror - Advanced code editor
  • TaskMaster AI (Optional) - AI-powered project management and task planning

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 Agent community.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages