Truero CLI

Understand and clean your data before it causes problems.

Run data-quality and ML validation checks on your machine, then optionally upload the report (not your raw file) to the Truero dashboard.

Prerequisites & Python Setup

• Python Version: Python 3.11+ is recommended (Python 3.10+ supported).
• macOS Note: Avoid the default system Python 3.9 (its bundled LibreSSL causes SSL warnings and syntax incompatibilities with modern libraries). Use Homebrew Python (brew install python@3.11), pyenv, or pipx.

Need to install Python 3.11?

Install

Recommended (Isolated CLI via pipx):

pipx install truero

With Python 3.11+ directly:

python3.11 -m pip install --upgrade truero

In a virtual environment:

python3.11 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
python -m pip install --upgrade truero

Quick start

In the same environment where you installed Truero:

truero scan data.csv

Supported files: CSV, JSON, Excel (.xlsx / .xls), Parquet.

Optional browser wizard (same checks, GUI):

truero web

Upload to the dashboard

After a scan, the CLI asks:

Upload report to Truero dashboard? [Y/n]:

1. Type Y (or press Enter) to upload, or n to skip.
2. If you have not saved a User ID yet, enter it when prompted — copy it from Dashboard → Settings (Profile).
3. You can save the ID for future runs (~/.truero/config.json). After that you will not be asked again until you change or reset it.

You can also set the User ID up front:

# Environment variable
TRUERO_USER_ID=YOUR-UUID-HERE truero scan data.csv

# Or flag
truero scan data.csv --user-id YOUR-UUID-HERE

# Or save once
truero config set-user YOUR-UUID-HERE

Skip the upload prompt entirely:

truero scan data.csv --no-upload

Upload sends the report summary only — never your raw dataset.

Optional configuration

API/dashboard URLs can also be set in the web wizard Settings, or in ~/.truero/config.json (web_api_url, web_dashboard_url).

Useful commands

truero scan path/to/file.csv
truero web
truero config show
truero config set-user YOUR-UUID-HERE

Links

• Website: https://www.truero.ai
• Dashboard: https://dashboard.truero.ai