# WebCode
**Repository Path**: jmh2018/WebCode
## Basic Information
- **Project Name**: WebCode
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-05
- **Last Updated**: 2026-03-13
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# WebCode
็ฎไฝไธญๆ | English
๐ Your AI Workspace, Anywhere | ้ๆถ้ๅฐ๏ผAI ๅทฅไฝๅฉๆ
Remote AI Assistant supporting coding, document processing, requirement analysis, report writing, and more across all platforms
---
## ๐ Online Demo
Want to try it quickly? No installation required, just visit the online demo:
| Demo URL | Username | Password |
|----------|----------|----------|
| **[https://webcode.tree456.com/](https://webcode.tree456.com/)** | `treechat` | `treechat@123` |
> โ ๏ธ **Note**: This demo environment is for demonstration purposes only. Please do not store sensitive information.
---
## ๐ฌ Community
Join our WeChat group to get the latest updates, report issues, and share your experiences:
---
## โจ Core Features
WebCodeCli is an **online AI-powered workspace platform** that allows you to remotely control various AI CLI assistants through a web browser, enabling **true work anywhere, anytime** - whether you're on the subway, in a coffee shop, or lounging on the sofa, you can code, write documents, analyze requirements, and more with just a browser!
### ๐ฏ Main Features
#### ๐ป Programming & Development
- **๐ค Multiple AI Assistant Support** - Integration with mainstream AI programming tools like Claude Code CLI, Codex CLI, GitHub Copilot CLI, etc.
- **โก Real-time Streaming Output** - Instantly see AI's thinking and coding process with typewriter effect
- **๐จ Code Highlighting Preview** - Monaco Editor with syntax highlighting for multiple languages
#### ๐ Document Processing
- **๐ Document Creation** - Generate and edit documents in Markdown, Word, PDF, and more
- **๐ Format Conversion** - Convert between different document formats seamlessly
- **๐ Data Visualization** - Process tabular data and generate charts
#### ๐ฏ Requirement Analysis
- **๐ Requirements Documentation** - Auto-generate PRDs, user stories, and feature specifications
- **๐ Requirement Clarification** - AI-assisted requirement analysis and optimization suggestions
- **๐ Priority Assessment** - Smart evaluation of requirement priorities and workload
#### ๐ Report Writing
- **๐ Project Reports** - Auto-generate project progress and summary reports
- **๐ Data Analysis Reports** - Data insights and visualization reports
- **๐ผ Business Documents** - Business plans, proposals, and more
#### ๐ ๏ธ Universal Features
- **๐ฑ Cross-Platform Support** - Full mobile optimization, seamless experience across phones, tablets, and computers
- **๐ Session Workspace** - Isolated working directories for each session, secure and reliable
- **๐ Secure Execution** - Sandbox environment, command whitelist, injection protection
## ๐ฅ๏ธ Supported AI CLI Tools
### โ
Fully Supported (Streaming JSON Parsing)
| Tool | Command | Features | Status |
|------|---------|----------|--------|
| **Claude Code CLI** | `claude` | MCP server, session recovery, stream-json output, proxy system | ๐ข Enabled |
| **Codex CLI** | `codex` | Sandbox execution, web search, Git integration, JSONL output | ๐ข Enabled |
| **OpenCode CLI** | `opencode` | GitHub Models integration, multi-model support, streaming output | ๐ข Enabled |
### ๐ง To Be Extended
| Tool | Command | Features | Status |
|------|---------|----------|--------|
| **GitHub Copilot CLI** | `copilot` | GitHub integration, fine-grained permissions | ๐ก Configured, pending adaptation |
| **Qwen CLI** | `qwen` | YOLO mode, checkpoints, extension system | ๐ก Configured, pending adaptation |
| **Gemini CLI** | `gemini` | Google AI, simple configuration | ๐ก Configured, pending adaptation |
> ๐ For detailed CLI tool usage instructions, please refer to [cli/README.md](./cli/README.md)
>
> ๐ก **Extension Support**: To add new CLI tool adapters, please refer to the existing implementations in the `WebCodeCli.Domain/Domain/Service/Adapters/` directory
## ๐ฑ Mobile Support
WebCodeCli is fully optimized for mobile devices:
- **Responsive Layout** - Adapts to phones, tablets, and desktop screens
- **Touch Optimization** - 44px touch targets, gesture support, press feedback
- **iOS Adaptation** - Solves Safari 100vh issue, adapts to notch screens
- **Portrait/Landscape Switching** - Seamless switching without content loss
- **Virtual Keyboard Adaptation** - Auto-adjusts viewport during input
### ๐ฑ Mobile-Compatible UI
- **Top navigation & quick actions** - Small-screen-first layout with fast access to core tools
- **Chat bubble layout** - Clear reading and smooth scrolling
- **Bottom input & shortcuts** - Touch-friendly controls that reduce mis-taps
- **Bottom tab bar** - Quick access to Chat / Output / Files / Preview / Settings

### Tested Device Support
- โ
iPhone SE / iPhone 12-14 / iPhone Pro Max
- โ
iPad Mini / iPad Pro
- โ
Android phones (various sizes)
- โ
Chrome / Safari / Firefox / Edge mobile versions
## ๐งญ First-Run Setup Wizard
On first install, you will be guided through the setup page (/setup) to complete initialization:



## ๐ผ๏ธ Screenshots
> These images are demo assets included in the repo; the actual UI may vary by version.




## ๐ Quick Start
### Option 1: Docker One-Click Deployment (Recommended)
**No configuration required, start in 30 seconds!** The system will automatically guide you through all configuration on first visit.
```bash
# Clone the project
git clone https://github.com/shuyu-labs/WebCode.git
cd WebCode
# One-click start
docker compose up -d
# Visit http://localhost:5000
# First visit will automatically enter the setup wizard
```
> ๐ For detailed deployment documentation, see [DEPLOY_DOCKER.md](./DEPLOY_DOCKER.md)
>
> ๐ง For pre-provisioning (env vars / unattended deploy) and built-in CLI verification, see [docs/Docker-CLI-้ๆ้จ็ฝฒๆๅ.md](./docs/Docker-CLI-้ๆ้จ็ฝฒๆๅ.md)
#### Updating Docker Deployment
To update to the latest version:
```bash
# Navigate to project directory
cd WebCode
# Pull latest code
git pull
# Stop and remove containers
docker compose down
# Remove old image
docker rmi webcodecli:latest
# Rebuild and start
docker compose up -d
```
### Option 2: Local Development
#### Requirements
- .NET 10.0 SDK
- Installed AI CLI tools (such as Claude Code CLI, Codex CLI)
#### Installation and Running
```bash
# Clone the project
git clone https://github.com/shuyu-labs/WebCode.git
cd WebCode
# Restore dependencies
dotnet restore
# Run the application
dotnet run --project WebCodeCli
```
The application will start at `http://localhost:5000`, visit `/code-assistant` to start coding!
### Configure CLI Tools
By default, you do not need to edit appsettings.json. On first visit, you will enter the setup wizard (/setup) to initialize settings in the Web UI; later you can adjust Claude/Codex/OpenCode in System Settings.
Use appsettings.json / environment variables only if you want pre-provisioning (CI/CD, unattended deployment, or fast local switching).
Example (advanced):
```json
{
"CliTools": {
"Tools": [
{
"Id": "claude-code",
"Name": "Claude Code",
"Command": "claude",
"ArgumentTemplate": "-p \"{prompt}\"",
"Enabled": true
},
{
"Id": "codex",
"Name": "OpenAI Codex",
"Command": "codex",
"ArgumentTemplate": "exec \"{prompt}\"",
"Enabled": true
}
]
}
}
```
## ๐๏ธ Technical Architecture
```
WebCodeCli/
โโโ WebCodeCli/ # Main project (Blazor Server)
โ โโโ Components/ # Blazor components
โ โโโ Pages/ # Pages
โ โ โโโ CodeAssistant/ # Programming assistant page
โ โโโ wwwroot/ # Static resources
โ โโโ Program.cs # Application entry
โโโ WebCodeCli.Domain/ # Domain layer (DDD)
โ โโโ Domain/
โ โ โโโ Model/ # Domain models
โ โ โโโ Service/ # Domain services
โ โ โโโ Adapters/ # CLI adapters
โ โโโ Repositories/ # Data repositories
โโโ cli/ # CLI tools documentation
```
### Tech Stack
| Category | Technology |
|----------|------------|
| **Frontend Framework** | Blazor Server + Tailwind CSS |
| **Code Editor** | Monaco Editor |
| **AI Features** | Microsoft Semantic Kernel |
| **Data Access** | SqlSugar ORM (Sqlite/PostgreSQL) |
| **Real-time Communication** | Server-Sent Events (SSE) |
| **Process Management** | System.Diagnostics.Process |
## ๐ Features
### Chat & Interaction
- โ
Left-right split layout (top-bottom on mobile)
- โ
Message history
- โ
Streaming output (typewriter effect)
- โ
Shortcut send (Ctrl+Enter)
- โ
Clear session
### Preview & Display
- โ
Code highlighting preview (Monaco Editor)
- โ
Markdown rendering
- โ
HTML live preview
- โ
Raw output view
- โ
Multi-tab switching
### Workspace Management
- โ
Session-isolated workspace
- โ
File upload/download
- โ
File tree browsing
- โ
Auto-cleanup of expired workspaces
### Security Features
- โ
Command whitelist validation
- โ
Input escaping (injection prevention)
- โ
Concurrency limits
- โ
Timeout control
## ๐ Documentation
- [Quick Start Guide](./docs/QUICKSTART_CodeAssistant.md)
- [Code Assistant Usage Guide](./docs/README_CodeAssistant.md)
- [CLI Tool Configuration Guide](./docs/CLIๅทฅๅ
ท้
็ฝฎ่ฏดๆ.md)
- [Mobile Compatibility Guide](./docs/็งปๅจ็ซฏๅ
ผๅฎนๆงไผๅ่ฏดๆ.md)
- [Codex Configuration Guide](./docs/Codex้
็ฝฎ่ฏดๆ.md)
- [Environment Variables Configuration](./docs/็ฏๅขๅ้้
็ฝฎๅ่ฝ่ฏดๆ.md)
## ๐ก Recommended Skills
Excellent Skills resources to enhance AI programming assistant capabilities:
- [**planning-with-files**](https://github.com/OthmanAdi/planning-with-files) - File-based project planning and task management skill
- [**Anthropic Skills**](https://github.com/anthropics/skills) - Official Anthropic Skills collection providing various Claude enhancement capabilities
- [**UI/UX Pro Max Skill**](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) - Professional UI/UX design and development skill
> ๐ก **Tip**: These Skills can be used with AI assistants like Claude Code CLI to enhance code generation, project planning, UI design capabilities, and more.
## ๐ง Use Cases
### ๐ป Programming & Development
- **Mobile Coding** - Handle code tasks on your phone anytime, emergency bug fixes without limits
- **Remote Development** - Drive AI assistants via browser, no local environment needed
- **Code Review** - AI-assisted code review, test case generation, and refactoring
- **Learning Programming** - Interactive learning with AI, instant feedback for beginners
### ๐ Documentation Work
- **Technical Documentation** - API docs, technical specs, system design documents
- **Project Documentation** - Project plans, progress reports, summary documents
- **User Manuals** - Product guides, operation manuals, FAQ documentation
- **Internal Documentation** - Meeting minutes, work logs, knowledge base organization
### ๐ฏ Product Management
- **Requirement Analysis** - PRD writing, user story breakdown, priority assessment
- **Feature Design** - Feature specifications, interaction design docs, prototype descriptions
- **Project Planning** - Milestone planning, task decomposition, resource estimation
- **Data Analysis** - User feedback analysis, data reports, trend insights
### ๐ผ Business Office
- **Business Documents** - Business plans, project proposals, partnership agreements
- **Report Writing** - Work summaries, analysis reports, performance reviews
- **Communication** - Email writing, announcements, training materials
- **Creative Planning** - Marketing proposals, event planning, content creation
## ๐ ๏ธ Advanced Configuration
### Workspace Configuration
```json
"CliTools": {
"TempWorkspaceRoot": "D:\\Temp\\WebCodeCli\\Workspaces",
"WorkspaceExpirationHours": 24,
"NpmGlobalPath": "",
"MaxConcurrentExecutions": 3,
"DefaultTimeoutSeconds": 300
}
```
| Configuration | Description | Example Value |
|---------------|-------------|---------------|
| `TempWorkspaceRoot` | Temporary workspace root directory for storing session-isolated working files | `D:\\Temp\\WebCodeCli\\Workspaces` |
| `WorkspaceExpirationHours` | Workspace expiration time (hours), automatically cleaned after expiration | `24` |
| `NpmGlobalPath` | NPM global installation path (optional, leave empty for auto-detection) | `C:\\Users\\YourUsername\\AppData\\Roaming\\npm\\` or leave empty `""` |
| `MaxConcurrentExecutions` | Maximum concurrent executions | `3` |
| `DefaultTimeoutSeconds` | Default timeout (seconds) | `300` |
> ๐ก **Tips**:
> - **Windows Users**: NPM global path is typically `C:\Users\{username}\AppData\Roaming\npm\`
> - **Linux/Mac Users**: NPM global path is typically `/usr/local/bin/` or `~/.npm-global/bin/`
> - Workspace directory should use absolute path with sufficient disk space
## ๐ค Contributing
Issues and Pull Requests are welcome!
## ๐ License
This project uses the **AGPLv3** open source license.
- Open Source Usage: Follow the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html) agreement
- Commercial Licensing: For commercial licensing, please contact **antskpro@qq.com**
For details, please refer to the [LICENSE](LICENSE) file.
---
๐ Let AI be your coding companion, anytime, anywhere ๐