README
¶
ScopeDB CLI
scope is the command-line interface for ScopeDB.
ScopeDB CLI is currently available as a release candidate for testing.
Install
Download a prebuilt archive for macOS, Linux, or Windows from GitHub Releases, extract it, and place the scope binary in your PATH.
To install the current release candidate from source, use Go 1.27 or newer:
go install github.com/scopedb/scopedb-cli/cmd/scope@v0.1.0-rc.1
Get started
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. To select another workspace:
scope workspace list
scope workspace use <id-or-name>
scope status
Query output
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.
Automation
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
Development tools are managed with mise:
mise install
mise run check
mise run test:race
mise run build
License
Apache License 2.0. See LICENSE.
Directories