How-To Guides

Task-oriented guides for common Canopy workflows. Each guide covers one specific goal with copy-pasteable steps, expected output, and common pitfalls.

Editor setup

Connect Canopy to your editor via MCP so code intelligence tools are available in AI-assisted workflows.

Set Up Canopy with Claude Code — Add Canopy to .mcp.json and verify 21 tools appear in Claude Code
Set Up Canopy with Cursor — Configure .cursor/mcp.json for Cursor IDE
Set Up Canopy with Zed — Add Canopy as a context server in Zed’s settings
Set Up Canopy with VS Code + Continue — Connect Canopy to the Continue extension for VS Code

CI integration

Run Canopy health checks automatically on every pull request.

GitHub Actions Integration — Surface P0/P1 findings as PR annotations
GitLab CI Integration — Publish findings as a Code Quality report on merge requests
CI Cached Indexes (Team tier) — Skip re-indexing on every run using remote cache

Repo configuration

Tune Canopy for your specific repository structure.

Configure Monorepo — Set entry points, ignored paths, and workspace config for monorepos
Multi-Language Repo — Index TypeScript, Python, Rust, Go, and JavaScript simultaneously
Team Shared Configs — Commit .canopy/team.yml so all developers use consistent rules

Extending Canopy

Add project-specific rules and integrate with other tools.

Write a Custom Health Check — Define YAML plugins for project-specific patterns
Migrate from Sourcegraph — Replicate Sourcegraph search and navigation after the indie tier was discontinued
Use Canopy Alongside GitHub Copilot — Combine structural intelligence with Copilot completions

Debugging

Diagnose and fix common Canopy problems.

Debug Slow Indexing — Find what’s taking time and fix it with ignored_paths and size limits
Debug Symbol Resolution Issues — Fix broken imports, missing symbols, and path alias failures

For problems not covered here, see the Troubleshooting section or email [email protected] with the output of canopy status and canopy health attached.