Skip to main content

​
Commands

CommandPurpose
goldencheck <file>Scan and launch the interactive TUI.
goldencheck scan <file>Explicit scan (--smart, --guided).
goldencheck validate <file>Validate against goldencheck.yml rules.
goldencheck review <file>Scan plus validate, then launch the TUI.
goldencheck init <file>Interactive setup wizard (scan → config → CI).
goldencheck diff <file> [file2]Compare two files, or against git HEAD (--ref main).
goldencheck watch <dir>Poll a directory and re-scan on change (--interval 30).
goldencheck fix <file>Auto-fix issues (--mode safe|moderate|aggressive, --dry-run).
goldencheck baseline <file>Deep-profile and save a statistical baseline to YAML.
goldencheck learn <file>Generate LLM validation rules.
goldencheck historyShow scan history and trends.
goldencheck serveStart the REST API server (--port 8000).
goldencheck scan-db <conn>Scan a database table directly.
goldencheck schedule <files>Run scans on a cron schedule (--interval, --webhook).
goldencheck mcp-serveStart the MCP server (19 tools).
The TypeScript CLI mirrors the core commands under goldencheck-js (scan, validate, profile, health-score, baseline, fix, diff, demo).

​
Key flags

FlagValuesEffect
--no-tui—Print results to the console.
--json—JSON output.
--fail-onerror, warningExit non-zero at this severity.
--domainhealthcare, finance, ecommerce, real_estate, people_hrApply a domain pack.
--llm-boost—Enable LLM enhancement.
--llm-provideranthropic (default), openaiChoose the LLM provider.
--modesafe, moderate, aggressiveFix mode (for fix).
--smart—Auto-triage: pin high-confidence, dismiss low.
--webhookURLPOST findings to Slack, PagerDuty, or a custom endpoint.
--baselinepathBaseline YAML for drift detection.

​
Config

A goldencheck.yml pins explicit rules for CI: 
version: 1

settings:
  sample_size: 100000
  fail_on: error

columns:
  email:
    type: string
    required: true
    format: email
    unique: true
  age:
    type: integer
    range: [0, 120]
  status:
    type: string
    enum: [active, inactive, pending, closed]

relations:
  - type: temporal_order
    columns: [start_date, end_date]

ignore:
  - column: notes
    check: nullability
Relation types: temporal_order, null_correlation, numeric_cross_column, and age_vs_dob.

​
Environment variables

VariableEffect
ANTHROPIC_API_KEYLLM boost (default provider).
OPENAI_API_KEYLLM boost (alternative provider).
GOLDENCHECK_LLM_BUDGETMax spend per scan, in USD.
GOLDENCHECK_SAMPLE_SIZEOverride the default sample size (100K rows).
GOLDENCHECK_DOMAINDefault domain pack.