CLI Overview

The Qarion CLI (qarion) is a command-line interface for the Qarion Lightweight AI and Data Governance platform. It wraps the Python SDK so you can manage spaces, products, quality checks, connectors, issues, and alerts without writing any code.

When to Use the CLI

The CLI is the fastest way to interact with Qarion from a terminal. Typical use-cases include:

• Ad-hoc inspection — quickly list products, check quality status, or search the catalog.
• CI/CD pipelines — trigger quality checks, push external results, or register products as part of a deployment workflow.
• Scripting — combine qarion with jq, grep, and shell scripts using the --json flag.

If you need deeper programmatic control (custom error handling, async workflows, complex orchestration), use the Python SDK directly.

Global Options

Every command inherits these options from the root qarion group:

Option	Env Variable	Default	Description
--api-key	QARION_API_KEY	required	API key for authentication
--base-url	QARION_BASE_URL	http://localhost:8000	Platform API base URL
--timeout	—	30.0	Request timeout in seconds
--json	—	off	Output JSON instead of tables
--version	—	—	Print CLI version and exit

Command Groups

Group	Description
spaces	List spaces and members
products	Browse, create, and manage data products
quality	Run and inspect quality checks
connectors	Manage data connectors and sync jobs
issues	Create and track issue tickets
alerts	View and resolve central alerts
search	Search across platform entities
permissions	Check your roles and permissions

Quick Examples

List all spaces in table format:

qarion spaces list

┌──────┬──────────────────┬──────────┬──────────────────┐
│ Slug │ Name             │ ID       │ Created          │
├──────┼──────────────────┼──────────┼──────────────────┤
│ acme │ Acme Analytics   │ 550e84…  │ 2026-01-10 09:00 │
└──────┴──────────────────┴──────────┴──────────────────┘

The same query as JSON for scripting:

qarion --json spaces list | jq '.[].slug'

"acme"

Trigger a quality check and inspect the result:

qarion quality trigger acme row-count-check

Next Steps

1. Installation & Configuration — install the CLI and set up your credentials.
2. Products — manage data products in the catalog.
3. Quality Checks — run and monitor quality checks.