Install the CLI

The ScopeDB CLI runs queries and manages a workspace from a terminal or script. Its executable is scope. These guides cover 0.2.0, currently in public preview.

Install

Download a release

Download v0.2.0 for your platform:

Download the release's SHA-256 checksums and compare the digest for your archive before extracting it. On macOS, use shasum -a 256 <archive>; on Linux, use sha256sum <archive>; on Windows, use Get-FileHash <archive> -Algorithm SHA256 in PowerShell.

On macOS or Linux, extract the archive and put scope on your PATH. For example, from a directory containing only the downloaded ScopeDB CLI archive:

tar -xzf scope_*.tar.gz scope
mkdir -p "$HOME/.local/bin"
install -m 0755 scope "$HOME/.local/bin/scope"
export PATH="$HOME/.local/bin:$PATH"
scope version

Add the export PATH=... line to your shell profile to keep scope available in new terminals. On Windows, extract the ZIP, add the directory containing scope.exe to your PATH, then run scope version.

Official Homebrew, Scoop, and winget packages are not available yet. Use the release archives or Go source instead of an unverified package with a similar name.

Build from source

With Go 1.27 or later:

go install github.com/scopedb/scopedb-cli/cmd/scope@v0.2.0

The binary is installed in GOBIN, or $(go env GOPATH)/bin when GOBIN is unset. Ensure that directory is on your PATH before running scope version. To install or update to the newest release version, replace @v0.2.0 with @latest; this does not follow repository main.

Connect and next steps

Sign in and select a workspace to use the CLI interactively, then run queries, manage Catalog definitions, or create and revoke API keys. For CI or unattended jobs, configure an endpoint and API key; no CLI login is required.