paraql 0.1.0

Command-line client for Parascope: run ParaQL queries, browse schema, and script exports

paraql

paraql is the command-line client for Parascope, a CMDB that discovers your infrastructure and maps how it fits together. It runs ParaQL queries against your tenant's API and prints the answer as a table, JSON, CSV, or a bare value you can pipe into the next command.

The PyPI package named parascope is unrelated to this project and is not published by us. This client is paraql.

Install

pip install paraql

Or, to keep it in its own environment:

pipx install paraql

Connecting

paraql talks to your Parascope tenant, so it needs two things: the tenant endpoint (https://<slug>.parascope.io) and an API key. There is no built-in default endpoint; if neither is configured, paraql says so and exits instead of guessing.

The guided setup writes ~/.paraql/config.toml with mode 0600:

paraql config init

Environment variables work too, and are handy in CI:

export PARAQL_ENDPOINT="https://acme.parascope.io"
export PARAQL_API_KEY="ps_ro_..."

Command-line flags win over environment variables, which win over the config file. Check what resolved, with the key masked:

paraql config show

The endpoint must be https. Plain http is accepted for local addresses such as localhost, or elsewhere if you pass --insecure, which sends the API key in the clear.

--timeout and --insecure are group-level flags, so they go before the subcommand:

paraql --timeout 120 query "SELECT name FROM kubernetes.pod"

Running a query

paraql "SELECT name, namespace FROM kubernetes.pod WHERE config.phase = 'Running' LIMIT 10"

A bare query is shorthand for paraql query. Pick a format with -o and the result becomes scriptable:

paraql -o json "SELECT name, criticality_score FROM openstack.instance" | jq '.[].name'

Interactive mode

paraql -i opens a REPL with persistent history and schema-aware completion. Running paraql with no arguments in a terminal does the same. Inside it, \? lists the backslash commands and \q quits.

$ paraql -i
paraql> SHOW TABLES
paraql> SELECT name, ci_type FROM kubernetes.pod LIMIT 5
paraql> \q

Documentation

• CLI reference: https://<slug>.parascope.io/docs/cli
• ParaQL language reference: https://<slug>.parascope.io/docs/paraql-reference

paraql --help lists the subcommands, and paraql <subcommand> --help covers each one.

License

Apache-2.0. See the Apache License 2.0.