ScopeQL: ScopeDB Command Line Interface

Overview

scopeql provides a command line interface and interactive shell for ScopeDB.

Installation

You can install scopeql with Cargo:

cargo install scopeql

Or you can download pre-built binaries from the releases page.

Or you can use the Docker image:

docker run -it --rm scopedb/scopeql

Configuration

scopeql reads its default connection settings from config.toml. Each connection can optionally define an API key, which is sent as an Authorization: Bearer <key> header on requests.

default_connection = "default"

[connections.default]
endpoint = "https://<cell>.<provider>.scopedb.cloud"
auth = "api_key"
api_key = "your-api-key"
headers = ["X-Tenant: acme"]

You can also override connection settings with environment variables such as SCOPEQL_CONFIG_CONNECTIONS_<CONNECTION_NAME>_ENDPOINT, SCOPEQL_CONFIG_CONNECTIONS_<CONNECTION_NAME>_API_KEY, and SCOPEQL_CONFIG_CONNECTIONS_<CONNECTION_NAME>_HEADERS. The SCOPEQL_CONFIG_CONNECTIONS_<CONNECTION_NAME>_HEADERS value should use newline-separated KEY: VALUE entries, matching the headers = ["KEY: VALUE"] TOML format.

Logs

Logs are written to the .scopeql/logs/ subdirectory of the platform's cache directory (falling back to $HOME/.scopeql/logs/). The default log level is INFO. To change the log level, set the RUST_LOG environment variable, e.g., RUST_LOG=debug for more verbose output.

License

This project is licensed under Apache License, Version 2.0.