Skip to main content

tui

Interactive terminal UI for exploring a sample of a dataset (not the whole file). Requires pip install "undatum[tui]" and a real TTY.

pip install "undatum[tui]"
undatum tui data.csv
undatum tui data.parquet --limit 500
undatum tui workbook.xlsx --table Sheet2
undatum tui nested.jsonl --flatten-nested

Keys: q quit, ? help, o open, s profile, f frequency on the selected column, / filter the sample, e export the current view, w convert/save as (full file, --low-memory), v validate the sample, m mask preview, p export pipeline YAML, : command palette, ctrl+s SQL (default LIMIT 500 on the data view), Tab cycle panes. From the file picker, u opens a local path or s3:// / gs:// / az:// URI. The status line shows the equivalent CLI command. Recent files are stored as paths only in ~/.undatum/tui-history.json. Use table / profile / sql when you are not on an interactive terminal.

Reference​

Reads: any readable format · Writes: interactive terminal view · Memory: bounded: a sample of rows · Engines: auto, duckdb, python

undatum tui [OPTIONS] [INPUT_FILE]
ArgumentDescription
INPUT_FILEPath to a data file. Opens a file picker if omitted.
OptionDescriptionDefault
-n, --limit INTEGERSample rows to show in the grid (default 200, max 5000).200
-d, --delimiter TEXTCSV delimiter character (auto-detected when omitted).
--quotechar TEXTCSV quote character (iterabledata default '"' when omitted).
--encoding TEXTFile encoding (e.g. 'utf8', 'latin1').
-F, --format-in TEXTOverride input file format detection (e.g. 'csv', 'jsonl').
-e, --engine [auto|duckdb|python]Processing engine: auto (default), duckdb, or python.
--table, --sheet TEXTTable or sheet name for multi-table sources (Excel, SQLite, lakehouse).
--start-page INTEGERSheet index (0-based) for Excel files.0
--trustAcknowledge pickle deserialization risk when reading pickle sources.
--on-error TEXTParse-error policy: raise (default), skip, or warn.
--error-log TEXTAppend parse errors as JSONL (use with --on-error skip or warn).
--flatten-nestedUnfold nested dict / array-of-dict fields into dotted paths (e.g. city.lat).
--max-nested-depth INTEGERWith --flatten-nested, maximum nest depth to unfold (engine default 5).
--keep-nested-parents / --no-keep-nested-parentsWith --flatten-nested, keep parent dict/array fields alongside dotted children.--keep-nested-parents
--verbose / --no-verboseEnable verbose logging output.--no-verbose

See also shared options.