ScopeDB CLI

scope is the command-line interface for ScopeDB.

Download the release archive for your platform from GitHub Releases:

Compare the archive's SHA-256 digest with its entry in checksums.txt, extract it, and place scope (scope.exe on Windows) in a directory on your PATH.

For example, after extracting the archive on macOS or Linux:

mkdir -p "$HOME/.local/bin"
install -m 0755 scope "$HOME/.local/bin/scope"
scope version

Ensure $HOME/.local/bin is on your PATH before running scope.

With Go 1.27 or newer:

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

Sign in to ScopeDB Cloud and run a query:

scope login
scope status
scope query 'SELECT 1 AS ready'
scope query 'FROM system.tables LIMIT 10'

scope login prompts for an email address and verification code, then stores the session in the operating system keyring. A pending account or an account without a workspace can stay logged in; scope status shows the account status and next steps. Run scope open to check approval status or create your first workspace in the Console. Once a workspace is available, select it without logging in again:

scope workspace list
scope workspace use <id-or-name>
scope status

Queries can be provided inline, from a file, or through stdin. Results can be rendered as a table, JSON, JSON Lines, or CSV.

scope query --file report.scopeql --format json
scope query 'FROM system.tables LIMIT 10' --format csv --output tables.csv

Run scope --help or scope <command> --help for the complete command reference. See the ScopeDB documentation for ScopeQL and service documentation.

For CI and other non-interactive environments, set the data-plane endpoint and API key:

export SCOPEDB_ENDPOINT="https://your-workspace.example.com"
export SCOPEDB_API_KEY="your-api-key"

scope doctor
scope query --format json 'SELECT 1 AS ready'

Both variables are required.

Development tools are managed with mise:

mise install
mise run check
mise run test:race
mise run build

Apache License 2.0. See LICENSE.