Skip to main content

Qualytics CLI

Command-line interface for the Qualytics data quality platform.

PyPI Python Tests License: MIT

Manage connections, datastores, containers, quality checks, anomalies, and operations as code. Export your entire Qualytics configuration to git-tracked YAML files and deploy across environments through CI/CD pipelines.

Installation

pip install qualytics-cli

Or with uv (faster):

uv pip install qualytics-cli

Requirements: Python 3.10 or higher.

Quick Start

# 1. Authenticate via browser (recommended)
uv run qualytics auth login --url "https://your-instance.qualytics.io/"

# 2. Check connectivity and API compatibility
qualytics doctor

# 3. Export your datastore configuration to YAML
qualytics config export --datastore-id 1 --output ./qualytics-config

# 4. Preview what an import would do (without making changes)
qualytics config import --input ./qualytics-config --dry-run

Commands

Group Description
auth Authenticate and manage credentials
connections Create and manage database connections
datastores Create and manage datastores
containers Create and manage computed containers
checks Create and manage quality checks
dbt Migrate dbt tests to Qualytics quality checks
migrate Create checks and computed containers from a check sheet
anomalies View and manage detected anomalies
operations Trigger sync, profile, and scan operations
config Export and import configuration as code
users List and view users
teams List and view teams
tags Manage tags (list, create, delete)
schedule Schedule recurring operations
mcp Start the MCP server for LLM integration
doctor Check CLI health, connectivity, and API compatibility

Run qualytics <command> --help for full details on any command.

Documentation

Guide Description
Getting Started Authentication, configuration, environment variables
Connections Creating and managing database connections
Datastores Creating and managing datastores
Quality Checks Creating checks from YAML (single and bulk)
Operations Sync, profile, scan workflows
Export/Import Config-as-code: export, import, CI/CD promotion
dbt Migration Converting a dbt manifest into quality checks
Check Sheet Migration Bulk checks + computed containers from a normalized XLSX/CSV sheet
Anomalies Viewing and managing anomalies
Computed Fields User-defined computed fields in export/import
Computed Tables Bulk import of computed tables from Excel/CSV
MCP Server LLM integration with Claude Code, Cursor, etc.
CI/CD Promotion GitHub Actions workflow for environment promotion

Development

git clone https://github.com/Qualytics/qualytics-cli.git
cd qualytics-cli
uv sync                              # Install dependencies
uv run pytest                        # Run tests
uv run pre-commit run --all-files    # Lint, format, type checks

For architecture details and contribution guidelines, see AGENTS.md.

Releasing

Releases are automated via GitHub Actions. The version lives in pyproject.toml and is managed by uv version.

Steps to release a new version

  1. Ensure main is green -- CI (lint + tests across Python 3.10-3.14 + pre-commit) must pass.

  2. Trigger the Release workflow -- Go to Actions > Release and click Run workflow. Select the bump type:

    • patch -- bug fixes (1.0.0 → 1.0.1)
    • minor -- new features (1.0.0 → 1.1.0)
    • major -- breaking changes (1.0.0 → 2.0.0)
  3. The workflow automatically:

    • Bumps the version in pyproject.toml via uv version --bump <type>
    • Commits the change and creates a v{version} git tag
    • Pushes the commit and tag to main
  4. The tag push triggers the Publish workflow, which:

    • Builds the package (uv build)
    • Publishes to PyPI via OIDC trusted publishing (no API tokens needed)
    • Creates a GitHub Release with auto-generated release notes and attached artifacts

Manual version check

# Current version in pyproject.toml
uv version --short

# Installed version
qualytics --version

License

MIT License -- see LICENSE for details.

Metadata

Release files for qualytics-cli 1.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qualytics-cli 1.2.2
File Size Uploaded
qualytics_cli-1.2.2.tar.gz 418.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qualytics-cli 1.2.2
File Interpreter ABI Platform
qualytics_cli-1.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 600.2 kB

Release files / qualytics_cli-1.2.2.tar.gz

Download URL qualytics_cli-1.2.2.tar.gz
Size 418.5 kB
Tags Source
SHA-256 checksum
How to use checksums
00a04f3efb1c8c06dc2ea2cc20fe15919252aa0534f65cf0f2e2611e71ca8555
BLAKE2b-256 checksum
How to use checksums
5e500c25492d34ae7caceb74fdf469335105cf6763f445f9f6d68826e92d2096
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / qualytics_cli-1.2.2-py3-none-any.whl

Download URL qualytics_cli-1.2.2-py3-none-any.whl
Size 181.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4ff15aaaa5c07b248cc03b967ea203ac85ac621c4acc9f9909535d34a78d494a
BLAKE2b-256 checksum
How to use checksums
85280a5dc913b601af89723877309be00039095539a32d319516fcb0ad143284
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

1.2.2 This release

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page