Skip to main content

config

Inspect the resolved CLI defaults from undatum.yaml, ~/.undatum/config.yaml, and UNDATUM_* environment variables.

undatum config
undatum config show

Example project undatum.yaml:

ai:
provider: openai
model: gpt-4o-mini
timeout: 30
defaults:
engine: duckdb
threads: 4
progress: true
encoding: utf8
delimiter: ","
quotechar: '"'
format_out: json

defaults: keys: engine, threads, progress, encoding, delimiter, quotechar, format_out.

Precedence​

CLI defaults (defaults: / UNDATUM_*): later sources win — environment, then ~/.undatum/config.yaml, then ./undatum.yaml. Explicit CLI flags override all of them.

EnvironmentConfig key
UNDATUM_ENGINEdefaults.engine
UNDATUM_THREADSdefaults.threads
UNDATUM_PROGRESSdefaults.progress
UNDATUM_ENCODINGdefaults.encoding
UNDATUM_DELIMITERdefaults.delimiter
UNDATUM_QUOTECHARdefaults.quotechar
UNDATUM_FORMAT_OUTdefaults.format_out

AI settings (ai:): environment, then the first config file found (./undatum.yaml preferred over ~/.undatum/config.yaml), then CLI flags. Provider API keys (OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY, ...) apply to ai * and every --autodoc command. pii_mask_samples: true|false overrides the default masking of AI samples (masked for remote providers). See AI documentation.

Reference​

undatum config show​

undatum config show [OPTIONS]
OptionDescriptionDefault
-O, --format-out TEXTOutput format: 'yaml' (default) or 'json'.yaml
--jsonPrint the result as one JSON document (same as --format-out json).

See also shared options.