Beta · version 0.8.1 · commands and the JSON format may still change.
Tabalyst Report
Tabalyst Report analyzes a CSV, JSON, JSONL or Excel file and produces an interactive, self-contained HTML report and a JSON profile of the same analysis. It reads the file once, as a stream, on your computer.
tabalyst report customers.csvThis creates customers.html (the report), customers.json (the profile) and
executions.json (the run history) beside the source. Your data is never
modified or sent anywhere.
Commands at a glance
Section titled “Commands at a glance”| Use case | Command | Destination |
|---|---|---|
| One file, automatic name | tabalyst report data.csv | data.html beside the source |
| One file, custom name | tabalyst report data.csv -o report.html | The file report.html |
| Several files, automatic names | tabalyst report *.csv | Beside each source |
| Several files, one directory | tabalyst report *.csv -d reports/ | The directory reports/ |
| One JSON file | tabalyst report data.json | data.report.html beside the source |
| One JSONL file | tabalyst report events.jsonl | events.report.html beside the source |
| One Excel workbook | tabalyst report sales.xlsx | sales.report.html beside the source |
| One page per column, and the charts | tabalyst report data.csv --details | The folder data/ beside the report |
| From a scan document | tabalyst report --scan data.scan.json | data.html beside the scan |
What the report shows
Section titled “What the report shows”- Dataset dimensions, missing cells, duplicates and quality observations.
- A family and a type for each column (identifier, text, date, boolean…), with the evidence behind them, and the technical type with its error rates.
- A summary table with one row per column: its type, a sentence about its values, the missing share, its Errors and Issues with a preview of each, and its details; above it, the Findings and Errors and Issues cards.
- Numeric, date and string-length analysis, normalization and value distributions.
- Distinct values, representative examples, date formats and detected meanings such as enumerations, email addresses, phone numbers and postal codes.
- CSV record widths, quoting, encoding and delimiter configuration.
- Findings classified as issues or remarks, with every count labelled exact, at least, estimated or sample.
- Structural patterns of text columns.
- A bounded sample of raw rows (start, sampled and end), while every record is analyzed.
The report is built on Tabalyst Scan. Values of
sensitive fields, such as email addresses, are shown by default; the
exposure settings
mask or hide them. Ambiguous
dates stay ambiguous: the report shows the evidence without applying it. The
HTML works without a network connection or a CDN; only the chart pages
of --details load a charting library from one.
- Read the report: interpret every HTML section, its tables, indicators and limits.
- Chart pages: the interactive charts
--detailswrites beside the report, starting with the combinations of missing values. - Findings catalog: every Error, Issue and Information finding, with its code, what it counts, its detail and its limits.
- Types and patterns: shared types and detectors, with a dedicated pattern catalog.
- Create your first report: a five-minute tutorial on a small CSV file.
- Report CSV files: names, batches, safe behavior and options.
- Report JSON and JSONL files: JSON and JSONL sources, one collection of records per report.
- Report Excel workbooks:
.xlsxand.xlsmsources, one table per report. - JSON profile: the structure of the generated
.jsonfile, and its changelog. - Execution history: the
executions.jsonfile. - Configuration: adapt the analysis and the presentation.