A desktop and mobile UI for
[qwen CLI](https://github.com/QwenLM/qwen-code), Google's official CLI
for AI-assisted coding. You can use it locally or remotely to view your active
projects and sessions in qwen CLI and make changes to them the same way you
would do it in qwen CLI. This gives you a proper interface that works
everywhere.
https://gitee.com/masx200/qwen-code-api-server
## Screenshots
Chat View
Main interface showing project overview and chat
Setting
Setting
Chat View
qwen-code-cli-UI Diagram
## Features
- **Responsive Design** - Works seamlessly across desktop, tablet, and mobile so
you can also use qwen CLI from mobile
- **Interactive Chat Interface** - Built-in chat interface for seamless
communication with qwen CLI
- **Integrated Shell Terminal** - Direct access to qwen 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 Selection** - Choose from multiple qwen models including qwen 2.5
Pro
- **YOLO Mode** - Skip confirmation prompts for faster operations (use with
caution)
## Quick Start
### Prerequisites
- [Node.js](https://nodejs.org/) v20 or higher
- [qwen CLI](https://github.com/QwenLM/qwen-code) installed and
configured
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/masx200/qwen-code-cli-ui.git
cd qwen-code-cli-UI
```
2. **Install dependencies:**
```bash
npm install
```
3. **Configure environment:**
```bash
cp .env.example .env
# Edit .env with your preferred settings
```
**Note**: The `.env` file has been removed for security. Always copy
`.env.example` to `.env` when using and modify settings as needed.
4. **Start the application:**
```bash
# Development mode (with hot reload)
npm run dev
```
The application will start at the port you specified in your .env
5. **Open your browser:**
- Development: `http://localhost:4009`
## Security & Tools Configuration
**๐ Important Notice**: All qwen CLI tools are **disabled by default**. This
prevents potentially harmful operations from running automatically.
### Enabling Tools
To use qwen CLI'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
### About YOLO Mode
YOLO mode ("You Only Live Once") is equivalent to qwen CLI's `--yolo` flag,
skipping all confirmation prompts. This mode speeds up your work but should be
used with caution.
**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 qwen CLI projects from `~/.qwen/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
#### Chat Interface
- **Use responsive chat or qwen CLI** - You can either use the adapted chat
interface or use the shell button to connect to qwen CLI
- **Real-time Communication** - Stream responses from qwen 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
- **Image Upload** - Upload and ask questions about images in chat
#### 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
- **Visualize Changes** - See current changes in real-time
- **Stage and Commit** - Create Git commits directly from the UI
- **Branch Management** - Switch and manage branches
#### 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 to Home Screen** - Add a shortcut to your home screen and the app will
behave like a PWA
## Architecture
### System Overview
```
โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ
โ Frontend โ โ Backend โ โ qwen CLI โ
โ (React/Vite) โโโโโบโ (Express/WS) โโโโโบโ Integration โ
โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ
```
### Backend (Node.js + Express)
- **Express Server** - RESTful API with static file serving (Port: 4008)
- **WebSocket Server** - Communication for chats and project refresh
- **qwen CLI Integration** - Process spawning and management
- **Session Management** - JSONL parsing and conversation persistence
- **File System API** - Exposing file browser for projects
- **Authentication System** - Secure login and session management (SQLite
database: qwencliui_auth.db)
### Frontend (React + Vite)
- **React 18** - Modern component architecture with hooks
- **CodeMirror** - Advanced code editor with syntax highlighting
- **Tailwind CSS** - Utility-first CSS framework
- **Responsive Design** - Mobile-first approach
## Configuration Details
### Port Settings
- **API Server**: Port 4008 (default)
- **Frontend Dev Server**: Port 4009 (default)
- These ports can be changed in the `.env` file
### ็ฏๅขๅ้้ ็ฝฎ
้กน็ฎๆฏๆไปฅไธ็ฏๅขๅ้้ ็ฝฎ๏ผ่ฏทๅจ `.env` ๆไปถไธญ่ฎพ็ฝฎ๏ผ
| ๅ้ๅ | ้ป่ฎคๅผ | ๆ่ฟฐ |
| ----------------------- | ------------------------------------- | ---------------------------------- |
| `qwen_PATH` | `qwen` | qwen CLI ็ๅฎ่ฃ ่ทฏๅพ |
| `HOME` | ็ณป็ป็จๆทไธป็ฎๅฝ | ็จๆทไธป็ฎๅฝ่ทฏๅพ |
| `PORT` | `4008` | API ๆๅกๅจ็ซฏๅฃ |
| `OPENAI_API_KEY` | - | OpenAI API ๅฏ้ฅ๏ผๅฏ้๏ผ |
| `OPENAI_BASE_URL` | - | OpenAI API ๅบ็ก URL๏ผๅฏ้๏ผ |
| `DB_PATH` | `./server/database/qwencliui_auth.db` | ๆฐๆฎๅบๆไปถ่ทฏๅพ |
| `JWT_SECRET` | ้ๆบ็ๆ | JWT ไปค็ๅ ๅฏๅฏ้ฅ |
| `API_KEY` | - | ๅค้จ API ๅฏ้ฅ๏ผๅฏ้๏ผ |
| `NODE_ENV` | `development` | ่ฟ่ก็ฏๅข๏ผdevelopment/production๏ผ |
| `OPENAI_MODEL` | - | OpenAI ๆจกๅๅ็งฐ๏ผๅฏ้๏ผ |
| `CUSTOM_LLM_MODEL_NAME` | - | OpenAI ๆจกๅๅ็งฐ๏ผๅฏ้๏ผ |
| `CUSTOM_LLM_API_KEY` | - | OpenAI API ๅฏ้ฅ๏ผๅฏ้๏ผ |
| `CUSTOM_LLM_ENDPOINT` | - | OpenAI API ๅบ็ก URL๏ผๅฏ้๏ผ |
| `USE_CUSTOM_LLM` | - | ๅฏ็จ่ชๅฎไน LLM ๆฏๆ๏ผๅฏ้๏ผ |
**็คบไพ้ ็ฝฎ**๏ผ
```bash
# .env ๆไปถ็คบไพ
qwen_PATH=/Users/username/qwen
HOME=/Users/username
PORT=4008
OPENAI_API_KEY=sk-your-openai-key-here
DB_PATH=./server/database/qwencliui_auth.db
JWT_SECRET=your-secret-key-here
API_KEY=your-api-key-here
NODE_ENV=development
```
### Database Configuration
#### Initial Setup and Table Structure
- **Database File**: `server/database/qwencliui_auth.db`
- **Database Type**: SQLite 3
- **Initialization**: Automatically created and initialized on server startup
#### User Table Details
**Table Name**: `qwencliui_users`
| Column | Data Type | Constraints | Description |
| --------------- | --------- | ------------------------- | ---------------------------------- |
| `id` | INTEGER | PRIMARY KEY AUTOINCREMENT | Unique user identifier |
| `username` | TEXT | UNIQUE NOT NULL | Login username (email recommended) |
| `password_hash` | TEXT | NOT NULL | bcrypt hashed password |
| `created_at` | DATETIME | DEFAULT CURRENT_TIMESTAMP | Account creation timestamp |
| `last_login` | DATETIME | NULL | Last login timestamp |
| `is_active` | BOOLEAN | DEFAULT 1 | Account active/inactive status |
**Indexes**:
- `idx_qwencliui_users_username`: For fast username lookups
- `idx_qwencliui_users_active`: For filtering active users
#### First Run Setup
1. On first server startup, database file is automatically created if it doesn't
exist
2. Table structure is loaded from `server/database/init.sql`
3. First access displays user registration screen
4. First user is registered as administrator
#### Security Features
- Passwords are hashed with bcrypt before storage
- JWT token-based authentication system
- Session management with timeout functionality
- SQL injection protection (prepared statements used)
## Troubleshooting
### Common Issues & Solutions
#### "No qwen projects found"
**Problem**: The UI shows no projects or empty project list **Solutions**:
- Ensure qwen CLI is properly installed
- Run `qwen` command in at least one project directory to initialize
- Verify `~/.qwen/projects/` directory exists and has proper permissions
#### 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
#### Model Selection Not Working
**Problem**: Selected model is not being used **Solutions**:
- After selecting a model in settings, make sure to click "Save Settings"
- Clear browser local storage and reconfigure
- Verify the model name is displayed correctly in the chat interface
## License
GNU General Public License v3.0 - see [LICENSE](LICENSE) file for details.
This project is open source and free to use, modify, and distribute under the
GPL v3 license.
### Original Project
This project is based on
[qwen Code UI](https://github.com/siteboon/qwencodeui) (GPL v3.0) with
customizations.
**Major Changes:**
- Adapted from qwen cli to qwen CLI
- Added authentication system (SQLite-based)
- qwen-specific model selection feature
- Enhanced Japanese language support
- UI adjustments and qwen branding
Thanks to the original qwen Code UI project.
## Acknowledgments
### Built With
- **[qwen CLI](https://github.com/QwenLM/qwen-code)** - Google's
official CLI
- **[React](https://react.dev/)** - User interface library
- **[Vite](https://vitejs.dev/)** - Fast build tool and dev server
- **[Tailwind CSS](https://tailwindcss.com/)** - Utility-first CSS framework
- **[CodeMirror](https://codemirror.net/)** - Advanced code editor
https://github.com/QwenLM/qwen-code
## Support & Community
### Stay Updated
- **Star** this repository to show support
- **Watch** for updates and new releases
- **Follow** the project for announcements
---
