`web`

Local browser UI for the same sampled session as tui (not a public Data API). Requires pip install "undatum[web]". Binds to 127.0.0.1:8765 by default.

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

Open a path or s3:// / gs:// / az:// URI, or upload a file (streamed to a temp directory). The page shows a bounded sample, equivalent CLI lines, profile, frequency, filter, SQL (default LIMIT 500), export, convert --low-memory, validate, mask, and pipeline YAML export. Use undatum api serve for a read-only machine API.

Reference

Reads: any readable format · Writes: local web page · Memory: bounded: a sample of rows · Engines: auto, duckdb, python

undatum web [OPTIONS] [INPUT_FILE]

Argument	Description
`INPUT_FILE`	Path to a data file. Opens an empty session if omitted.

Option	Description	Default
`--host` TEXT	Host to bind (default: 127.0.0.1).	`127.0.0.1`
`--port` INTEGER	Port to bind (default: 8765).	`8765`
`-n`, `--limit` INTEGER	Sample rows to show in the grid (default 200, max 5000).	`200`
`-d`, `--delimiter` TEXT	CSV delimiter character (auto-detected when omitted).
`--quotechar` TEXT	CSV quote character (iterabledata default '"' when omitted).
`--encoding` TEXT	File encoding (e.g. 'utf8', 'latin1').
`-F`, `--format-in` TEXT	Override input file format detection (e.g. 'csv', 'jsonl').
`-e`, `--engine` [auto\|duckdb\|python]	Processing engine: auto (default), duckdb, or python.
`--table`, `--sheet` TEXT	Table or sheet name for multi-table sources (Excel, SQLite, lakehouse).
`--start-page` INTEGER	Sheet index (0-based) for Excel files.	`0`
`--trust`	Acknowledge pickle deserialization risk when reading pickle sources.
`--on-error` TEXT	Parse-error policy: raise (default), skip, or warn.
`--error-log` TEXT	Append parse errors as JSONL (use with --on-error skip or warn).
`--flatten-nested`	Unfold nested dict / array-of-dict fields into dotted paths (e.g. city.lat).
`--max-nested-depth` INTEGER	With --flatten-nested, maximum nest depth to unfold (engine default 5).
`--keep-nested-parents` / `--no-keep-nested-parents`	With --flatten-nested, keep parent dict/array fields alongside dotted children.	`--keep-nested-parents`
`--open` / `--no-open`	Open the system browser (default: on a TTY).
`--api-key` TEXT	Optional API key. Also read from UNDATUM_API_KEY.
`--verbose` / `--no-verbose`	Enable verbose logging output.	`--no-verbose`

Reference​

Reference