Installation & Upgrade
The LATdx CLI ships as platform-specific release binaries hosted on GitHub. There is no npm install -g. This page covers binary install, release channels, and the in-place upgrade flow.
Supported Platforms
| Platform | Asset name |
|---|---|
| macOS Intel | latdx-darwin-x64 |
| macOS Apple Silicon | latdx-darwin-arm64 |
| Linux x64 | latdx-linux-x64 |
| Linux ARM64 | latdx-linux-arm64 |
| Windows x64 | latdx-win-x64.exe |
Windows ARM64 is not published.
Install (one-liner)
The install script downloads the right binary for your platform, drops it on your PATH, and runs latdx --help to verify:
curl -fsSL https://raw.githubusercontent.com/nebulity/latdx-cli/main/install.sh | bashwget works the same way:
wget -qO- https://raw.githubusercontent.com/nebulity/latdx-cli/main/install.sh | bashPin a specific version by passing it as the script argument:
curl -fsSL https://raw.githubusercontent.com/nebulity/latdx-cli/main/install.sh | bash -s 1.2.3Install (manual)
If you prefer not to pipe a remote script to bash, download the binary for your platform from GitHub Releases and place it on your PATH:
chmod +x ./latdx-<platform>
sudo mv ./latdx-<platform> /usr/local/bin/latdx
latdx --helpWindows (PowerShell):
Move-Item .\latdx-win-x64.exe $env:USERPROFILE\bin\latdx.exe
# Add $env:USERPROFILE\bin to PATH if it is not there
latdx --helpRelease Channels
LATdx publishes two channels:
| Channel | What you get | When to pick it |
|---|---|---|
stable | GitHub releases marked as non-prerelease. | Default. Pick this for daily work and CI. |
latest | Includes GitHub prereleases (-latest.N tags). | Pick this to track unreleased fixes; expect occasional regressions. |
Channels are managed via latdx config:
latdx config get channel # current channel (defaults to "stable")
latdx config set channel latest
latdx config list # all configured keysThe channel value is persisted to ~/.latdx/config.json. It controls which release stream both latdx upgrade and the background update check compare against.
Upgrade
In-place upgrade to the newest release on the configured channel:
latdx upgradeBehind the scenes this re-runs the install script with the latest version pinned, so it requires curl or wget and write access to the install location.
Check without installing:
latdx upgrade check
latdx upgrade check --json # { "currentVersion", "latestVersion", "updateAvailable" }check --json is suitable for cron jobs or CI: a non-zero updateAvailable is a signal that a newer build exists on the channel.
Background Update Notices
Every CLI invocation runs a non-blocking update check at most once per 24 hours. The result is cached at ~/.latdx/update-check.json. When a newer version is found on the configured channel, a one-line notice is printed to stderr after the command result:
Update available: 1.2.3 -> 1.2.4 (https://github.com/nebulity/latdx-cli/releases/latest)The notice never blocks the run. Network or disk failures are swallowed silently unless LATDX_DEBUG=1 is set, in which case the underlying error is logged to stderr.
To force a fresh check before the throttle expires, run latdx upgrade check (it always bypasses the cache).
Verifying the Install
latdx --version
latdx --version -o my-org # also prints managed-package status in the orgThe org-augmented form returns a non-zero exit code if it cannot query the org’s package version. Use it as a smoke test in CI before running tests.
Uninstall
The CLI is a single binary with no installer database. Remove it by deleting the file and, optionally, the per-user state directory:
sudo rm "$(command -v latdx)"
rm -rf ~/.latdx # config, caches, daemons, runner-access permset cacheTo remove LATdx artifacts from a Salesforce org as well, see latdx uninstall in the CLI Reference.