Installation

sqry ships pre-built binaries for all major platforms and is also available via crates.io and from source. This page covers all installation paths, shell completions, and how to build the MCP and LSP servers.

macOS and Linux (recommended)

The install script downloads sqry, sqry-mcp, and sqry-lsp into ~/.local/bin (override with --install-dir):

curl -fsSL https://raw.githubusercontent.com/verivus-oss/sqry/main/scripts/install.sh | bash -s -- --component all

Add --verify-signatures to enforce Cosign bundle verification (requires cosign). Current published macOS binaries target Apple Silicon (arm64) only.

Windows (recommended)

The PowerShell installer places sqry.exe, sqry-mcp.exe, and sqry-lsp.exe into %LOCALAPPDATA%\Programs\sqry\bin and adds that directory to the user PATH:

irm https://raw.githubusercontent.com/verivus-oss/sqry/main/scripts/install.ps1 | iex

Review-first variant with signature verification:

Invoke-WebRequest https://raw.githubusercontent.com/verivus-oss/sqry/main/scripts/install.ps1 -OutFile install.ps1
Get-Content .\install.ps1
.\install.ps1 -VerifySignatures

Pin a specific release:

.\install.ps1 -Version v6.0.18 -VerifySignatures

Manual fallback: download sqry-windows-x86_64.zip from the releases page, extract sqry.exe, sqry-mcp.exe, and sqry-lsp.exe, and place them in a directory on PATH.

Package Managers

Release packaging configs are generated from signed release checksums and included in release assets:

Primary install methods provide sqry, sqry-mcp, and sqry-lsp. Raw binaries and .bundle files are advanced/manual verification assets.

From crates.io

Install from source via cargo:

cargo install sqry-cli

The sqry binary is placed in ~/.cargo/bin/. Make sure this directory is in your PATH (rustup adds it automatically on most systems).

All 35 language plugins are compiled in by default, including IaC languages (Terraform, Puppet, Pulumi).

Requirements: Rust 1.90+ (Edition 2024). About 20 GB disk for a full build (35 tree-sitter grammars are compiled from source).

From Source

Clone the repository and install all three binaries:

git clone https://github.com/verivus-oss/sqry.git
cd sqry
cargo install --path sqry-cli
cargo install --path sqry-mcp
cargo install --path sqry-lsp

To build release binaries without installing system-wide:

cargo build --release --package sqry-cli
cargo build --release --package sqry-mcp
cargo build --release --package sqry-lsp

The compiled binaries are placed at target/release/sqry, target/release/sqry-mcp, and target/release/sqry-lsp. Copy them to any directory in your PATH:

cp target/release/sqry target/release/sqry-mcp target/release/sqry-lsp ~/.local/bin/

Verify

Confirm the installation succeeded:

sqry --version

You should see output like sqry 6.0.19 (version numbers vary). To list all 35 supported languages and their file extensions:

sqry --list-languages

Shell Completions

sqry can generate completion scripts for Bash, Zsh, Fish, and PowerShell.

Bash:

sqry completions bash >> ~/.bashrc
# Or for system-wide completions:
sqry completions bash > /etc/bash_completion.d/sqry

Zsh:

sqry completions zsh > ~/.zfunc/_sqry
# Ensure ~/.zfunc is in your fpath in ~/.zshrc:
# fpath=(~/.zfunc $fpath)
# autoload -Uz compinit && compinit

Fish:

sqry completions fish > ~/.config/fish/completions/sqry.fish

PowerShell:

sqry completions powershell > sqry.ps1
# Source the file from your PowerShell profile

After adding completions, start a new shell session (or source the relevant file) for them to take effect.

Completions cover all subcommands (query, search, graph, index, unused, cycles, diff, explain, similar, impact, batch, shell, workspace, cache, config, mcp, lsp, etc.), their flags, and valid values for enum flags like --kind, --lang, --format, and --scope. In shells that support it (Zsh, Fish), descriptions are shown alongside each completion candidate.

MCP Binary

sqry includes a native MCP (Model Context Protocol) server that exposes 33 JSON-RPC tools for AI assistants such as Claude, Codex, Gemini, Cursor, and Windsurf.

If you used the platform install scripts above, sqry-mcp is already installed. To build it separately from source:

git clone https://github.com/verivus-oss/sqry.git
cd sqry
cargo build --release --package sqry-mcp

The binary is placed at target/release/sqry-mcp. See the MCP Integration page for assistant-specific configuration.

LSP Binary

sqry ships an LSP server supporting hover, definition, references, call hierarchy, document/workspace symbols, code actions, and 27 custom sqry/* methods. It works with VS Code, Neovim, Helix, and any LSP 3.17 client. Socket mode is available for shared instances.

If you used the platform install scripts above, sqry-lsp is already installed. To build it separately from source:

git clone https://github.com/verivus-oss/sqry.git
cd sqry
cargo build --release --package sqry-lsp

The binary is placed at target/release/sqry-lsp. See the LSP Integration page for editor configuration.