Skip to content

User Guide

Comprehensive guide to using Truthound for data quality validation.

Sections

  • CLI Reference

    Complete command-line interface reference

    CLI Reference

  • Validators

    Guide to 289 built-in validators across 28 categories

    Validators

  • Profiling

    Data profiling and rule generation

    Profiling

  • CI/CD Integration

    Integrate with your deployment pipeline

    CI/CD

  • Configuration

    Configuration files and options

    Configuration

Quick Reference

Common CLI Commands

# Core commands
truthound learn <file>       # Learn schema from data
truthound check <file>       # Validate data quality
truthound scan <file>        # Scan for PII
truthound mask <file>        # Mask sensitive data
truthound profile <file>     # Basic profiling

# Advanced profiling
truthound auto-profile <file>     # Comprehensive profiling
truthound quick-suite <file>      # Profile + generate rules
truthound generate-suite <file>   # Generate rules from profile

# Checkpoints (CI/CD)
truthound checkpoint init         # Create sample config
truthound checkpoint run <name>   # Run checkpoint
truthound checkpoint list         # List checkpoints

# Documentation
truthound docs generate <file>    # Generate HTML report
truthound dashboard               # Launch interactive dashboard

Python API Overview

import truthound as th

# Core functions
report = th.check("data.csv")      # Validate
profile = th.profile("data.csv")   # Profile
schema = th.learn("data.csv")      # Learn schema
pii = th.scan("data.csv")          # Scan PII
masked = th.mask("data.csv")       # Mask data
drift = th.compare(old, new)       # Detect drift