canopy.nvim

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 13 Open GitHub ↗

Neovim plugin for canopy - toggle between your editor and AI agent dashboard

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# canopy.nvim

Neovim plugin for [canopy](https://github.com/isacssw/canopy) - open your AI agent dashboard seamlessly from your editor.

## Features

- **Open canopy** in a floating window, horizontal or vertical split
- **Statusline** component (lualine) showing agent counts in real time
- **Worktree picker** via Telescope — switch nvim's cwd to any worktree
- **Send input** to waiting agents without opening the dashboard
- **`e` keybinding** in canopy's diff view opens files in your parent nvim at the right line

## Requirements

- [canopy](https://github.com/isacssw/canopy) `>= 0.4.0` (needs `canopy status` subcommand)
- [tmux](https://github.com/tmux/tmux)
- Neovim `>= 0.10.0`
- Optional: [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) for the worktree picker
- Optional: [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim) for statusline integration

## Installation

### [lazy.nvim](https://github.com/folke/lazy.nvim)

```lua
{
  "isacssw/canopy.nvim",
  dependencies = { "nvim-telescope/telescope.nvim" }, -- optional
  opts = {},
  keys = {
    { "<leader>ac", desc = "Open canopy" },
    { "<leader>aw", desc = "Canopy worktrees" },
    { "<leader>as", desc = "Send to agent" },
  },
}
```

### Lualine integration

```lua
{
  "nvim-lualine/lualine.nvim",
  opts = function(_, opts)
    table.insert(opts.sections.lualine_x, 1, require("canopy").lualine())
  end,
}
```

## Configuration

```lua
require("canopy").setup({
  prefix = "<leader>a",       -- keymap prefix
  layout = "float",           -- "float" | "horizontal" | "vertical"
  float_size = {
    width = 0.85,             -- fraction of editor width
    height = 0.85,            -- fraction of editor height
  },
  split_height = 20,          -- rows for horizontal split
  split_width = 80,           -- cols for vertical split
  statusline = true,          -- enable status polling for lualine
  poll_interval = 3000,       -- ms between status polls
  canopy_cmd = "canopy",      -- path to canopy binary
})
```

## Keymaps

| Keymap | Command | Description |
|--------|---------|-------------|
| `<leader>ac` | `:Canopy` | Open canopy dashboard |
| `<leader>aw` | `:CanopyWorktrees` | Pick a worktree (Telescope) |
| `<leader>as` | `:CanopySend` | Send input to a waiting agent |
| `<leader>ar` | `:CanopyRefresh` | Refresh status now |

## How it works

```
nvim                          canopy (TUI)
  │                              │
  ├── canopy.nvim polls ──────► canopy status --json
  │   (every 3s, async)          │
  │                              ├── queries tmux sessions
  │                              └── queries git worktrees
  │
  ├── <leader>ac ──────────────► runs canopy in nvim terminal buffer
  │                              │
  │                              ├── press 'e' in diff view
  │                              │   └── nvim --server $NVIM --remote-send
  │                              │       └── opens file in parent nvim
  │
  ├── <leader>aw ──────────────► Telescope picker → vim.cmd.cd(worktree)
  │
  └── <leader>as ──────────────► tmux send-keys → agent session
```

## Health check

```
:checkhealth canopy
```

Verifies: canopy binary, tmux, git repo, telescope (optional).

## License

MIT

canopy.nvim

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README