Codemux Documentation
Complete documentation for Codemux, the terminal-first agent development environment.
Codemux Documentation
Codemux is a terminal-first agent development environment (ADE) built with Tauri, React, and Rust. It gives you workspaces with terminal panes, an embedded browser, git integration, and multi-agent orchestration — all in one window.
Quick Start
- Install Codemux from source
- Launch and create your first workspace
- Open a terminal with
Ctrl+T, 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
- 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, review, and merge PRs
- Merge Resolver — AI-powered merge conflict resolution
Features
- Agent Status Indicators — Real-time agent activity tracking
- File Editor — Built-in editor for quick file edits and reviews
- Notifications — Desktop notifications, attention badges, and status indicators
- Port Detection — Auto-detected listening ports
- Settings — Appearance, terminal, git, and AI tool configuration
- Authentication — Sign in to sync settings across devices
- Setup Scripts — Automatic project setup and teardown
- OpenFlow — Multi-agent orchestration
Reference
- Browser Agent Commands — CLI and socket API for browser automation
- CLI — Control a running Codemux instance from the terminal