Documentation
Everything you need to get started with Canopy — from installation to running multiple AI coding agents side by side on isolated Git worktrees.
New to Canopy?
Getting Started
Everything you need to get Canopy installed, configured, and opening your first project.
Core Concepts
The mental model behind Canopy — worktrees, workspaces, and how parallel agent delegation works.
- UI Layout Toolbar, sidebar, panel grid, dock, context menus, and multi-window
- Terminals & Panels Panel types, grid layout, terminal features, and QuickRun
- AI Agents Running Claude Code, Gemini CLI, Codex, Cursor, and OpenCode side by side
- Unified Input @file autocomplete, /commands, voice input, file pasting, and multi-line editing
Features
The tools built into each habitat — review, browsing, notes, voice input, recipes, and codebase snapshots.
- GitHub Integration Issues, pull requests, CI status, and repo stats
- Review Hub In-app git staging, commit, push, and diff review
- CopyTree Copy structured codebase snapshots to your clipboard for AI agents and tools
- Portal Browser Portal sidebar for AI chat, and Browser panels with console capture and DevTools
- Dev Preview Embedded browser with live dev server output, QuickRun sidebar, automatic script discovery, and Turbopack support
- Notes Project-scoped Markdown notes with preview and tags
- Recipes Saved workspace presets with global scope and variables
- Voice Input Speech-to-text dictation with AI-powered correction
Customization
Themes, settings, and keyboard shortcuts to make Canopy your own.
Reference
Logs, status codes, diagnostics, and technical details for troubleshooting and deep dives.
- Settings Global and project settings tabs, search with @modified filter, and modified indicators
- Plugin System Experimental plugin manifest, extension points, and API
- Security & Privacy Sandboxing, IPC hardening, git RCE protection, environment filtering, and data storage
- Session Management State persistence, scroll buffer serialization, hibernation, and sleep/wake
- Updates Auto-updates, stable/nightly channels, and CLI updates
- Troubleshooting Diagnostics, crash recovery, safe mode, and common issues
- Build from Source Clone the repository and build Canopy yourself