Quickstart: Check and Test an SFDX Project

Start

Use this path when you want the shortest install, doctor, check, and test loop for an SFDX project.

• Install the binary.
• Initialize local project config.
• Run one check and one focused test.

This path installs Glade, checks the project, and runs one focused test. For VS Code, CI, and report workflows, use the Tester field guide.

1. Install

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

If glade is not found, add ~/.local/bin to PATH and restart your shell.

Expected:

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.

Next:
  glade check
  glade test changed --since origin/main
  glade playground --examples --open

2. Open an SFDX project

cd path/to/sfdx-project
glade init --project . --yes
glade config validate --project .

Expected: glade.yml exists, and config validation exits with code 0.

3. Check source

glade check --project .

Expected:

• zero diagnostics and exit code 0
• or one or more file/line diagnostics and exit code 1

4. Run one test

glade test --project . --class RefinementServiceTest

Expected: a selected/passed/failed summary, plus file and method details for any failure.

5. Run affected tests

glade test changed --project . --since origin/main

Expected: Glade maps changed Apex and metadata to the smallest local test set it can prove.

6. Open the playground

glade playground --examples --open

Expected: Glade starts the browser workbench and prints the local URL, example mode, database mode, and stop command.

7. Know the limits

Glade is a local runtime, not a Salesforce emulator. Check what Glade runs locally before relying on platform service APIs, live auth, exact hosted Visualforce behavior, or REST and Tooling APIs outside the checked local baseline.