# Canopod documentation

Get Canopod running, set up your repository, and give each branch a workspace of its own.
Start with a guide below, or search for a setting, command, or problem.

 
[Install Canopod Choose a download for your platform and follow the installation guide.](https://canopod.com/download.html)
[Create your first worktree Go from a registered repository to a new branch with its own working directory.](https://docs.canopod.com/first-worktree.html)
[Connect a coding agent with MCP Set up Claude Code or Codex, choose repository access, and explore the 15 tools.](https://docs.canopod.com/mcp.html)
[Configure your repository Define the setup steps, service commands, and port rules your project needs.](https://docs.canopod.com/config-worktreemanager.html)
 

## Start on your own machine

New to Canopod? [What Canopod is](https://docs.canopod.com/overview.html) explains how worktrees, services, and agents fit together.
On a Mac with Apple Silicon, install with Homebrew:

```sh
brew install --cask emidhun/canopod/canopod
```

Follow [Install on macOS](https://docs.canopod.com/install-macos.html) for the first launch. [Windows](https://docs.canopod.com/install-windows.html)
and [Linux](https://docs.canopod.com/install-linux.html) packages are also available, but remain experimental and have not
been validated on a desktop.

Once installed, [add a repository](https://docs.canopod.com/onboarding.html), review the detected services and setup commands,
then follow [Your first worktree](https://docs.canopod.com/first-worktree.html). Canopod runs the commands you configure;
what gets installed or provisioned depends on your project.

## Connect Claude Code, Codex, or another MCP client

The optional local MCP server lets an agent inspect worktrees, read service logs, and work with
the repositories you allow. MCP is off by default. You choose repository access and grant worktree
creation, service control, and configuration changes separately.

[MCP and coding agents](https://docs.canopod.com/mcp.html) covers connection steps, permissions, all 15 tools, and headless
setup. For a guided introduction, [explore Canopod MCP](https://canopod.com/canopod-mcp.html).
Read [Security](https://docs.canopod.com/security.html) for the boundaries around local commands and connected clients.

## Find the part you need

 
[Branches and worktrees Create, switch between, and clean up worktrees without losing track of each branch.](https://docs.canopod.com/worktrees.html)
[Services and ports Configure the processes you run and assign ports using each worktree's index.](https://docs.canopod.com/services-ports.html)
[Postgres databases Configure database creation, snapshots, and restore workflows for your project.](https://docs.canopod.com/databases.html)
[Terminals and agents Open a shell or launch an agent with the context of the selected worktree.](https://docs.canopod.com/agents-terminals.html)
 

For the app itself, start with [The main window](https://docs.canopod.com/main-window.html), [Logs](https://docs.canopod.com/logs.html), and
[Keyboard shortcuts](https://docs.canopod.com/shortcuts.html). [Troubleshooting](https://docs.canopod.com/troubleshooting.html) connects common
symptoms to checks and fixes.

## Adapt an example to your project

Use a worked configuration for a [simple web app](https://docs.canopod.com/example-simple-web.html), a
[Node + Postgres app](https://docs.canopod.com/example-node-postgres.html), the [ToolJet monorepo](https://docs.canopod.com/example-tooljet.html),
or [Rails, Django, Go, and Rust](https://docs.canopod.com/example-other-stacks.html).
[Template variables](https://docs.canopod.com/config-variables.html) explains how paths, branch names, and port values
are passed into your commands.

Working on Canopod itself? See [Building from source](https://docs.canopod.com/dev-setup.html),
[Building a release](https://docs.canopod.com/prod-setup.html), and the [command and event reference](https://docs.canopod.com/reference-ipc.html).

## About these guides

These guides describe **Canopod 0.5.0**. [Limitations](https://docs.canopod.com/limitations.html) records platform support,
unfinished controls, and known boundaries. Controls marked *coming soon* are visible in the app
but are not implemented yet.

---

Canonical page: https://docs.canopod.com/
Product version: 0.5.0