Skip to content
Canopy is in pre-release. These docs describe the product at its public launch — commands, tool names, and integration examples reflect what you'll see once binaries ship. Join the waitlist →

Install Canopy

Canopy is a single static binary with no runtime dependencies. When it ships, you’ll download it, put it on your PATH, and run canopy --version. That’s the entire install.

Canopy ships as a single static binary per platform, packaged as a tarball named by its build target:

PlatformTarball
Linux (x86_64)canopy-x86_64-unknown-linux-gnu.tar.gz
Linux (aarch64)canopy-aarch64-unknown-linux-gnu.tar.gz
macOS (Apple Silicon)canopy-aarch64-apple-darwin.tar.gz
macOS (Intel)canopy-x86_64-apple-darwin.tar.gz
Windows (x86_64)canopy-x86_64-pc-windows-msvc.tar.gz

Releases are published to downloads.canopy.gulfshieldtech.com, with a manifest at /releases/latest.json listing per-platform tarballs and their SHA-256 hashes. No package managers, no runtime dependencies.

Terminal window
# Pick the tarball matching your platform (see the table above)
curl -fsSL https://downloads.canopy.gulfshieldtech.com/releases/latest/canopy-x86_64-unknown-linux-gnu.tar.gz \
| tar -xz -C ~/.local/bin
chmod +x ~/.local/bin/canopy
# Verify
canopy --version

Once installed, canopy update self-updates the binary in place after a signature and SHA-256 integrity check; canopy update --check reports the available version without installing.

Once installed:

Terminal window
canopy --version

Expected output (the version number is whatever the latest published binary is — clap auto-generates --version from CARGO_PKG_VERSION and does not append a platform suffix; the Pre-release callout above explains the launch versioning):

canopy 1.22.24

To confirm which platform binary you downloaded, check the file you saved (e.g. canopy-linux-x86_64) — the binary itself doesn’t echo its build target.

If canopy isn’t found after moving the binary:

Add to ~/.bashrc or ~/.zshrc:

Terminal window
export PATH="$HOME/.local/bin:$PATH"
# Move the binary there instead of /usr/local/bin if you prefer user-local installs

Then source ~/.bashrc or open a new shell.

On first run, macOS may block the binary with a “cannot be opened because it is from an unidentified developer” dialog.

Fix:

Terminal window
xattr -d com.apple.quarantine /usr/local/bin/canopy

Or: System Settings → Privacy & Security → scroll down → “Allow Anyway” next to the Canopy block.

If you have a license key (from a trial signup or purchase), activate it after install:

Terminal window
canopy activate <your-license-key>

Expected output:

canopy: license activated (tier: solo, expires: 2027-07-05)
canopy: machine fingerprint registered (1/1 slots used)

Confirm with canopy license — it prints your tier, expiry, and seat usage.

No license key yet? Canopy runs in Community Mode — the full local index and keyword answers, no account required. You can follow the rest of Getting Started as-is; canopy license prints the trial and pricing links whenever you’re ready.

Index your first repo — one command, and you have a structural model of your codebase.