Qualytics CLI

The Qualytics CLI is a command-line tool for managing your Qualytics data quality platform. It provides full control over connections, datastores, quality checks, operations, anomalies, and configuration — all from the terminal.

Installation

Prerequisites

Python 3.10 or higher

Need Python?

See our Python Installation Guide for step-by-step instructions on Windows.

Install via pip

pip install qualytics-cli

Install via uv (recommended)

uv pip install qualytics-cli

Upgrade

pip install qualytics-cli --upgrade

Quick Start

1. Authenticate — Open a browser login (recommended):

qualytics auth login --url https://your-instance.qualytics.io

Or configure with a token directly:

qualytics auth init --url https://your-instance.qualytics.io --token YOUR_TOKEN

2. Verify setup — Run diagnostics:

qualytics doctor

3. Start working — List your datastores:

qualytics datastores list

4. Run an operation — Sync, profile, and scan:

qualytics operations sync --datastore-id 1
qualytics operations profile --datastore-id 1
qualytics operations scan --datastore-id 1

Command Groups

The CLI organizes its functionality into these command groups:

Group	Description	Commands
`auth`	Authentication and configuration	`login`, `init`, `status`
`connections`	Database connection management	`create`, `update`, `get`, `list`, `delete`, `test`
`datastores`	Datastore management	`create`, `update`, `get`, `list`, `delete`, `verify`, `enrichment`
`containers`	Computed containers (tables, files, joins)	`create`, `update`, `get`, `list`, `delete`, `validate`, `import`, `preview`
`checks`	Quality check management	`create`, `get`, `list`, `update`, `delete`, `activate`, `export`, `import`, `export-templates`, `import-templates`
`anomalies`	Anomaly management	`get`, `list`, `update`, `archive`, `delete`
`operations`	Data processing workflows	`sync`, `profile`, `scan`, `materialize`, `export`, `get`, `list`, `abort`
`users`	User account listing	`list`, `get`
`teams`	Team listing	`list`, `get`
`tags`	Tag management	`list`, `get`, `create`, `delete`
`config`	Configuration as code	`export`, `import`
`schedule`	Scheduled exports	`export-metadata`
`mcp`	AI assistant integration	`serve`
`doctor`	Health diagnostics	(see below)

Doctor

Run qualytics doctor to verify your CLI setup. It performs 7 diagnostic checks:

qualytics doctor

  ✓ CLI version      Qualytics CLI v1.0.0
  ✓ Python version   3.12.0
  ✓ Configuration    ~/.qualytics/config.yaml
  ✓ Auth token       Token present
  ✓ Token expiry     Expires 2026-04-15
  ✓ API connectivity https://your-instance.qualytics.io — OK
  ✓ SSL certificate  Valid

  7 passed, 0 failed

Check	What it validates
CLI version	Current installed version
Python version	Python 3.10+ is available
Configuration	`~/.qualytics/config.yaml` exists
Auth token	A token is configured
Token expiry	Token is not expired
API connectivity	Can reach the Qualytics API
SSL certificate	SSL certificate is valid

Global Options

Output Format

Most get and list commands support --format:

qualytics connections list --format json
qualytics datastores get --id 1 --format yaml

Supported formats: yaml (default), json.

Help

View available commands and usage:

qualytics --help
qualytics connections --help
qualytics connections create --help

Environment Variables

Variable	Description
`QUALYTICS_URL`	Qualytics instance URL (overrides config file)
`QUALYTICS_TOKEN`	Auth token (overrides config file)
`QUALYTICS_NO_BANNER`	Set to suppress the startup banner
`CI`	When `true`, suppresses the banner (auto-set in CI environments)

Configuration File

The CLI stores its configuration at ~/.qualytics/config.yaml:

url: https://your-instance.qualytics.io
token: eyJhbGciOiJSUzI1NiIs...
verify_ssl: true

File permissions are set to 0600 (owner read/write only)
Environment variables (QUALYTICS_URL, QUALYTICS_TOKEN) take precedence over the config file
Legacy config.json files are automatically migrated to config.yaml

Secrets Management

Sensitive fields in connection definitions support ${ENV_VAR} syntax:

host: ${DB_HOST}
username: ${DB_USER}
password: ${DB_PASSWORD}

These placeholders are resolved from environment variables (or a .env file in the working directory) at import time. Secrets are never stored in plaintext in exported files.