Codemux Documentation
Complete documentation for Codemux, the agent development environment for native chat, terminals, workspaces, and browser automation.
Codemux Documentation
Codemux is an agent development environment (ADE) built with Tauri, React, and Rust. It gives you native multi-provider chat, workspaces with real terminal panes, an embedded browser, git integration, and orchestration — all in one window.
Quick Start
- Install Codemux from a release package or source
- Launch, choose a project, and write your first prompt in the chat draft
- Send to create the workspace, or open a terminal with
Ctrl+Tand split it withCtrl+Shift+D
Documentation
Core
- Overview — What Codemux is and how it works
- Installation — Build from source, system requirements
- Keyboard Shortcuts — Complete shortcut reference
Workspace & Layout
- Workspaces — Creating, managing, and organizing workspaces
- Workspaces Overview — Account-wide view of every workspace across every device, with push/pull/adopt actions
- Web Remote Access — Drive a desktop or headless Codemux instance from another browser, over your network or from anywhere
- Projects — Open, create, and manage projects with onboarding wizard
- Terminal — Terminal panes, tabs, splits, and configuration
- Browser — Embedded browser pane with agent automation
- Command Palette — Quick actions via
Ctrl+K
Git & Code Review
- Changes — Stage, commit, push, pull from the Changes panel
- Diff Viewer — Split/unified diff views with conflict highlighting
- Pull Requests — Create PRs and read their checks and review comments
- Reviewing & Merging — Line notes, verdicts, review threads, and merging in place
- The Pull Requests Page — Triage every request across the repos you have open
Features
- Agent Status Indicators — Real-time agent activity tracking
- File Editor — Built-in editor for quick file edits and reviews
- Session Persistence — Scrollback save/restore and automatic agent resume
- Notifications — Desktop notifications, attention badges, and status indicators
- Port Detection — Auto-detected listening ports
- Browser Viewport Presets — Resize the embedded browser for responsive testing
- Settings — Appearance, interface, terminal, git, and AI tools
- Themes & Typography — Pick or build a theme, and set fonts per surface
- Usage — Token and cost accounting per provider, model, and day
- Authentication — Sign in to sync settings and skills across devices
- Setup Scripts — Automatic project setup and teardown
- Automations — Scheduled agent runs on a recurring schedule
Agent Chat
The default native conversational surface for Claude, Codex, Cursor, and OpenCode. The classic terminal-first interface remains available under Settings → Interface.
- Agent Chat — Streaming chat, mode pills, plan proposals, multi-provider picker
- Attachments — Attach files, folders, GitHub issues, GitHub PRs, and images
- Skills Sync — Server-side cross-device skill sync
- MCP Servers — Host user-installed MCP servers in chat sessions
Reference
- Browser Agent Commands — CLI and socket API for browser automation
- CLI — Control a running Codemux instance from the terminal