Table of Contents
Claudia - GUI for Claude Code on Windows
Introduction
Claudia is a powerful desktop GUI application for Claude Code, built by Asterisk. It transforms the command-line Claude Code experience into a beautiful, intuitive visual interface with advanced features like custom agents, session management, usage analytics, and more.
What is Claudia?
Claudia serves as your command center for Claude Code, providing:
- ποΈ Visual Project Management - Browse Claude Code projects with a GUI
- π€ Custom AI Agents - Create specialized agents with custom prompts
- π Usage Analytics - Track API costs and token usage
- β° Session Timeline - Create checkpoints and navigate session history
- π MCP Server Management - Manage Model Context Protocol servers
- π CLAUDE.md Editor - Built-in markdown editor with live preview
System Requirements
Minimum Requirements
- OS: Windows 10 version 2004+ or Windows 11
- RAM: 4GB (8GB recommended)
- Storage: 1GB free space
- Prerequisites: Claude Code CLI installed and working
Required Tools
- Rust (1.70.0 or later)
- Bun (latest version)
- Git
- Visual Studio Build Tools (C++ support)
- WebView2 (usually pre-installed on Windows 11)
Prerequisites Installation
1. Install Claude Code CLI
First, ensure Claude Code is installed and working. Follow the Claude Code Windows Installation Guide.
# Verify Claude Code is installed claude --version
2. Install Rust
# Install Rust via rustup curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # Or on Windows, download from: https://rustup.rs/ # After installation, restart terminal and verify: rustc --version cargo --version
3. Install Bun
# Install Bun curl -fsSL https://bun.sh/install | bash # Or on Windows via PowerShell: powershell -c "irm bun.sh/install.ps1 | iex" # Verify installation bun --version
4. Install Visual Studio Build Tools
Download and install Visual Studio Build Tools with C++ support:
- Download βBuild Tools for Visual Studioβ
- Install with βC++ build toolsβ workload
5. Install Git
Download from https://git-scm.com/ or use winget:
winget install Git.Git
Installation Methods
Method 1: Pre-built Releases (Coming Soon)
Method 2: Build from Source
Step 1: Clone Repository
git clone https://github.com/getAsterisk/claudia.git cd claudia
Step 2: Install Dependencies
# Install frontend dependencies bun install
Step 3: Build Application
# For development (with hot reload) bun run tauri dev # For production build bun run tauri build
Common Build Issues and Solutions
Issue 1: Icon Problems
Problem: `error RC2175 : resource file icon.ico is not in 3.00 format`
Solution: Convert PNG to proper ICO format using ImageMagick:
# Install ImageMagick winget install ImageMagick.ImageMagick # Convert PNG to ICO magick "src-tauri/icons/128x128.png" "src-tauri/icons/icon.ico"
Issue 2: Bundle Configuration
Problem: `Couldn't find a .ico icon` during bundling
Solution: Add icon path to `src-tauri/tauri.conf.json`:
{ "bundle": { "icon": [ "icons/32x32.png", "icons/128x128.png", "icons/128x128@2x.png", "icons/icon.icns", "icons/icon.png", "icons/icon.ico" ] } }
Alternative: Build without bundling:
# Build executable only (no installer) bun run tauri build --no-bundle # Or modify package.json { "scripts": { "tauri": "tauri build --no-bundle" } }
Issue 3: MSVC Not Found
Problem: `MSVC not found` error during build
Solution:
- Install Visual Studio Build Tools with C++ support
- Restart terminal after installation
- Verify with: `cl.exe` (should be found in PATH)
Issue 4: Out of Memory
Problem: Build fails with memory errors
Solution:
# Build with fewer parallel jobs cargo build -j 2 # Or set environment variable set CARGO_BUILD_JOBS=2 bun run tauri build
Issue 5: WebView2 Missing
Problem: WebView2 runtime not found
Solution:
- Install βEvergreen Standalone Installerβ
- Restart system
Build Configuration Options
Development Build
# Fast compilation, larger binary, debug symbols
bun run tauri dev
Production Build
# Optimized build with installer bun run tauri build # Build without installer (executable only) bun run tauri build --no-bundle # Debug build (faster compilation) bun run tauri build --debug
Build Artifacts
After successful build, find files in:
src-tauri/target/release/ βββ claudia.exe # Main executable βββ bundle/ # Installers (if bundling enabled) βββ msi/ # MSI installer βββ nsis/ # NSIS installer
Running Claudia
First Launch
# Run the built executable cd src-tauri/target/release ./claudia.exe # Or from project root during development bun run tauri dev
Initial Setup
1. Welcome Screen: Choose between CC Agents or CC Projects 2. Auto-Detection: Claudia automatically finds your `~/.claude` directory 3. Project Import: Existing Claude Code projects are imported automatically
Using Claudia
Project Management
CC Projects β Select Project β View Sessions β Resume or Start New
- Browse all Claude Code projects visually
- View session history with timestamps
- Resume previous sessions or start new ones
- Search projects and sessions quickly
Creating Custom Agents
CC Agents β Create Agent β Configure β Execute
1. Design Agent: Set name, icon, and system prompt 2. Configure Model: Choose Claude model (Sonnet, Opus, etc.) 3. Set Permissions: Configure file access and network permissions 4. Execute Tasks: Run agent on any project
Usage Analytics
Menu β Usage Dashboard β View Analytics
- Monitor API costs by model and project
- Track token usage over time
- Export data for accounting
- Visual charts and trends
MCP Server Management
Menu β MCP Manager β Add Server β Configure
- Add Model Context Protocol servers
- Import from Claude Desktop configuration
- Test server connections
- Manage server permissions
Upgrading Claudia
From Source
# Navigate to Claudia directory cd claudia # Pull latest changes git pull origin main # Update dependencies bun install # Rebuild application bun run tauri build
Automated Update Script
#!/bin/bash # Save as update-claudia.bat echo "π Updating Claudia..." cd claudia git pull origin main echo "π¦ Installing dependencies..." bun install echo "π¨ Building application..." bun run tauri build --no-bundle echo "β Update complete!" echo "π Executable location: src-tauri/target/release/claudia.exe"
Advanced Configuration
Custom Build Settings
Create `.cargo/config.toml` in project root:
[build] jobs = 2 # Limit parallel jobs target-dir = "target" # Custom target directory [target.x86_64-pc-windows-msvc] rustflags = ["-C", "target-cpu=native"] # Optimize for your CPU
Environment Variables
# Set before building set RUST_LOG=debug # Enable debug logging set TAURI_DEBUG=true # Enable Tauri debug mode set CARGO_BUILD_JOBS=2 # Limit build parallelism set RUSTFLAGS="-C target-cpu=native" # CPU optimization
Tauri Configuration
Edit `src-tauri/tauri.conf.json` for custom settings:
{ "build": { "beforeBuildCommand": "bun run build", "beforeDevCommand": "bun run dev", "devPath": "http://localhost:5173", "distDir": "../dist" }, "bundle": { "active": false, // Disable bundling for faster builds "targets": ["nsis"], // Use NSIS instead of WiX "windows": { "certificateThumbprint": null, "digestAlgorithm": "sha256", "timestampUrl": "" } } }
Troubleshooting
Performance Issues
Slow Build Times:
# Use fewer CPU cores set CARGO_BUILD_JOBS=2 # Use faster linker (install first) cargo install -f cargo-binutils rustup component add llvm-tools-preview
High Memory Usage:
# Increase virtual memory # Control Panel β System β Advanced β Performance Settings β Virtual Memory # Set to 8GB+ if you have sufficient disk space
Runtime Issues
Application Won't Start:
- Verify WebView2 is installed
- Check Windows Defender/antivirus exclusions
- Run as Administrator (temporarily)
- Check Windows Event Viewer for errors
Claude Code Not Found:
# Verify Claude Code installation claude --version # Check PATH echo $PATH | grep -i claude # Reinstall if necessary npm install -g @anthropic-ai/claude-code
Development Setup
For Contributors
# Clone and setup development environment git clone https://github.com/getAsterisk/claudia.git cd claudia # Install dependencies bun install # Start development server bun run tauri dev # Run tests cd src-tauri && cargo test # Format code cd src-tauri && cargo fmt
Project Structure
claudia/ βββ src/ # React frontend β βββ components/ # UI components β βββ lib/ # API client & utilities β βββ assets/ # Static assets βββ src-tauri/ # Rust backend β βββ src/ β β βββ commands/ # Tauri command handlers β β βββ checkpoint/ # Timeline management β β βββ process/ # Process management β βββ tests/ # Rust test suite βββ public/ # Public assets
Security Considerations
Claudia prioritizes security:
- Process Isolation: Agents run in separate processes
- Permission Control: Granular file and network access
- Local Storage: All data stays on your machine
- No Telemetry: No data collection or tracking
- Open Source: Full code transparency
Useful Resources
FAQ
Q: Do I need Claude Code CLI installed?
A: Yes, Claudia is a GUI wrapper for Claude Code CLI. Install Claude Code first.
Q: Can I use Claudia without building from source?
A: Pre-built releases will be available soon. Currently, building from source is required.
Q: Why does the build take so long?
A: Rust compilation is thorough but slow. Use `βdebug` flag for faster development builds.
Q: Is Claudia free to use?
A: Yes, Claudia is open source (AGPL-3.0 license). You still need Claude API access.
Q: Can I contribute to Claudia?
A: Absolutely! Check the GitHub repository for contribution guidelines.