Skip to content

mengchencloud/kiro-cli-webui

Repository files navigation

Kiro CLI WebUI

A simplified web-based UI for Kiro CLI, focused on shell interaction, file management, and git operations.

Features

  • Shell Integration - Direct access to Kiro CLI through built-in terminal
  • File Explorer - Interactive file tree with syntax highlighting and live editing
  • Git Operations - View, stage and commit your changes, switch branches
  • Project Management - Manage multiple Kiro projects
  • Responsive Design - Works seamlessly across desktop, tablet, and mobile

Quick Start

Prerequisites

Installation

  1. Clone the repository:
git clone https://github.com/mengchen-tam/kiro-cli-webui.git
cd kiro-cli-webui
  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 automatic cleanup and hot reload)
npm run dev

# Alternative: Use the enhanced start script
npm run start-dev

# Manual cleanup if needed
npm run cleanup

The application will automatically clean up any conflicting processes and start at the port specified in your .env file (default: http://localhost:3009)

Usage

Core Features

Project Management

  • Visual Project Browser - All available Kiro projects with metadata
  • Project Actions - Create, rename, and delete projects
  • Smart Navigation - Quick access to recent projects

Shell Interface

  • Direct CLI Access - Use Kiro CLI commands directly in the web interface
  • Real-time Output - Stream responses and see command execution in real-time
  • Project Context - Automatically switches to the correct project directory

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 Integration

  • Status Overview - View current branch, staged/unstaged changes
  • Stage & Commit - Interactive staging and committing of changes
  • Branch Management - Switch between branches, view commit history

Mobile Support

  • Responsive Design - Optimized for all screen sizes
  • Touch-friendly Interface - Swipe gestures and touch navigation
  • Mobile Navigation - Bottom tab bar for easy thumb navigation

Architecture

System Overview

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

Backend (Node.js + Express)

  • Express Server - RESTful API with static file serving
  • WebSocket Server - Real-time communication for shell and project updates
  • Kiro CLI Integration - Process spawning and management
  • File System API - File browser and editor functionality

Frontend (React + Vite)

  • React 18 - Modern component architecture with hooks
  • CodeMirror - Advanced code editor with syntax highlighting
  • Responsive Design - Mobile-first approach with Tailwind CSS

Changes from Original

This version has been simplified to focus on Kiro CLI shell usage:

  • Removed Chat Interface - No longer includes the chat-based interaction
  • Shell-First Approach - Default tab is now the shell terminal
  • Simplified Navigation - Three main tabs: Shell, Files, Git
  • Streamlined UI - Removed session management and chat-related components

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

  • Kiro CLI - AI-powered development CLI
  • React - User interface library
  • Vite - Fast build tool and dev server
  • Tailwind CSS - Utility-first CSS framework
  • CodeMirror - Advanced code editor

Based On

This project is based on Claude Code UI but adapted for Kiro CLI usage.


Simplified for Kiro CLI usage.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors