Installation

Install

Recommended path: use the one-line installer, then run glade doctor.

• Use the script for macOS and Linux release archives.
• Use a manual archive when CI or policy requires pinned artifacts.
• Build from source when you are developing Glade.

Glade ships as a single local binary for macOS and Linux. Install it, verify your environment with glade doctor, then run your first project check from an SFDX workspace.

Choose an install path

Recommended

macOS/Linux scriptInstalls the current release to ~/.local/bin.

Pinned

Manual release archiveUse in CI or when policy requires pinned artifacts.

Source

Build from sourceUse for Glade development or unreleased changes.

Editor and CI

VS Code and automationInstall the bundled VS Code extension or place the binary in a CI runner.

One-line install

OS	CPU	Status
macOS	arm64	supported release archive
macOS	amd64	supported release archive
Linux	amd64	supported release archive
Linux	arm64	supported release archive
Windows	amd64/arm64	build from source for now

For macOS and Linux:

curl -fsSL https://glade.sh/install.sh | sh

The script installs the latest release to ~/.local/bin by default. Override the install directory or version when needed:

curl -fsSL https://glade.sh/install.sh | env GLADE_INSTALL_DIR=/usr/local/bin sh
curl -fsSL https://glade.sh/install.sh | env GLADE_VERSION=vX.Y.Z sh

Check the binary after it is on your path:

glade version
glade doctor

Expected: glade doctor prints status rows for the parser, toolchain, config, and runtime, then ends with Ready..

glade doctor
Glade doctor

Project      ✓ SFDX project found
Parser       ✓ ok (tree-sitter)
Toolchain    ✓ <glade data dir> (ok (global))
Config       ✓ glade.yml
Runtime      ✓ glade <version> · go<version> · <os>/<arch>

Ready.

Update Glade

Use the same installer path for updates. Check the command first when you want to see what will run:

glade update --dry-run
GLADE_UPDATE_ALLOW_SHELL=1 glade update
glade version
glade doctor

glade update prints the exact installer command before it runs. It updates the directory that contains the current glade binary. The environment guard keeps self-replacement explicit.

Manual fallback:

• Release archives: https://github.com/glade-sh/glade/releases
• Checksums: https://github.com/glade-sh/glade/releases/latest/download/SHA256SUMS.txt

Security verification

Release archives publish checksums and CycloneDX SBOMs. The release workflow also publishes GitHub artifact attestations when the repository host supports them. Use this path when policy requires pinned proof:

curl -L -o glade.tar.gz "$GLADE_RELEASE_URL"
curl -L -o SHA256SUMS.txt "$GLADE_CHECKSUMS_URL"
shasum -a 256 -c SHA256SUMS.txt
gh attestation verify glade.tar.gz -R glade-sh/glade
tar -xzf glade.tar.gz
./glade version
./glade doctor

Download the matching *.sbom.json release asset when your review process requires a dependency inventory. If no attestation is available for the release, use the checksum and SBOM as the release proof.

Install VS Code Extension

Release archives include the Glade VS Code extension at share/glade/editor/vscode-glade.vsix. After the glade binary is on your path, check the editor install path and install the bundled extension:

glade editor doctor vscode
glade editor install vscode --force

Open an SFDX project in VS Code. The extension adds Glade Home, a Glade Activity Bar, native Test Explorer entries, local CodeLens actions, DAP debug launches, named local data environments, Exec & SOQL scratch buffers, and a Plugins view for linked and installed plugin actions. See Editor, LSP, and DAP.

Build from source

Use this path when developing Glade or trying the current repository state before a release is cut.

Prerequisites:

• Go 1.26 or newer
• Git
• A C compiler with CGO enabled. On macOS, install Xcode Command Line Tools. On Debian or Ubuntu, install build-essential.

git clone https://github.com/glade-sh/glade.git
cd glade
go build -o glade ./cmd/glade
./glade version
./glade doctor

Run against an SFDX project. No Salesforce org login is required for these local commands:

./glade check --project path/to/sfdx-project --json
./glade test --project path/to/sfdx-project --json
./glade exec "System.debug('hello from source build');"

During development you can run the CLI without building a binary:

go run ./cmd/glade version
go run ./cmd/glade doctor
go run ./cmd/glade check --project path/to/sfdx-project

First project run

From an SFDX project root:

glade init --project . --yes
glade config validate --project .
glade config show --project .
glade check --project .
glade test --project . --json --no-progress

Run one class, one method, or tests affected by a git ref:

glade test --project . --class RefinementServiceTest --json
glade test --project . --class RefinementServiceTest --method testRefinesFileRow --json
glade test changed --project . --since origin/main --json --no-progress

CI usage

Build from source in GitHub Actions:

- uses: actions/setup-go@v5
  with:
    go-version-file: go.mod
- run: sudo apt-get update && sudo apt-get install -y build-essential
- run: CGO_ENABLED=1 go install github.com/glade-sh/glade/cmd/glade@latest
- run: glade doctor --json
- run: glade check --project .
- run: glade test --project . --json
- run: glade check --project . --format sarif --output glade-check.sarif

Or download a release artifact and verify checksums:

- run: |
    curl -L -o glade.tar.gz "$GLADE_RELEASE_URL"
    curl -L -o SHA256SUMS.txt "$GLADE_CHECKSUMS_URL"
    shasum -a 256 -c SHA256SUMS.txt
    gh attestation verify glade.tar.gz -R glade-sh/glade
    tar -xzf glade.tar.gz
    install -m 0755 glade ~/.local/bin/glade
    glade version

Troubleshooting

If glade is not found after install, add ~/.local/bin to your shell path:

export PATH="$HOME/.local/bin:$PATH"

Then open a new shell and run:

glade version
glade doctor

Next step

For a first project run, use the Tester field guide. For a narrow first run, create project config: Configure a Glade Project, then check What Glade runs locally.