.\" Generated by gen_docs from crates/datui-cli. Do not edit.
.TH DATUI\-CATALOG 1 2026-10-06 "datui 0.4.1" "User Commands"
.nr HY 0
.ds AD l
.SH NAME
datui\-catalog \- show the catalogs of named datasets on the home screen, or check a catalog file
.SH SYNOPSIS
.nf
\fBdatui catalog show\fR [\fINAME\fR]
\fBdatui catalog check\fR \fIFILE\fR
.fi
.SH DESCRIPTION
Show the catalogs of named datasets on the home screen, or check a catalog file.
.PP
A catalog is one TOML file of named datasets, local or remote, that the home screen lists as a section under its label. \fICONFIG\fR/catalog.toml is yours, and Ctrl+D on a home row adds to it; every \fICONFIG\fR/catalogs/*.toml is a catalog, named by its file, and \fBcatalogs\fR in the config lists files elsewhere; examples ships with datui, and a catalogs/examples.toml replaces it. A catalog's top level holds \fBlabel\fR and \fBdescription\fR; every other table is a dataset, keyed by a short id of lowercase letters, digits and \fB\-\fR. A dataset's keys: \fBname\fR (its row), \fBpath\fR or \fBurl\fR, \fBauth\fR (\fBauto\fR or \fBanonymous\fR) or \fBconnection\fR (a \fB[[cloud.connections]]\fR name), \fBdescription\fR, \fBpublisher\fR, \fBlicense\fR, \fBhomepage\fR, \fBdocumentation\fR (an https link), \fBsize\fR (a web file's bytes, shown until measured), \fBcolumns.NAME = { description, unit, values = { CODE = "meaning" } }\fR and \fBbookmarks."Name" = "path/"\fR. A long legend is a \fB[id.columns.NAME.values]\fR table, with the column's other keys written as dotted keys. \fBdatui catalog show examples\fR prints a worked example.
.SH COMMANDS
.TP
\fBdatui catalog show\fR
With NAME, print that catalog's file (examples is the one datui ships); without, list the catalogs: id, label, datasets and file.
.RS
.TP
\fINAME\fR
The catalog's id: mine (catalog.toml), examples, or a listed file's name.
.RE
.TP
\fBdatui catalog check\fR
Check a catalog file and list its datasets; a mistake is named by its line, with the fix, and exits non-zero.
.RS
.TP
\fIFILE\fR
The catalog file.
.RE
.SH OPTIONS
.TP
\fB\-c\fR, \fB\-\-config\fR \fIKEY=VALUE\fR
Set a config key for this run, as in the file: \-c display.\:row_numbers=true. Repeatable; a flag of the key's own still wins. \fBdatui config keys\fR lists them.
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help.
.SH "EXIT STATUS"
.TP
\fB0\fR
Success: the session was quit (q, Ctrl+Q or Ctrl+C), or the command did what it was asked.
.TP
\fB1\fR
An error, printed to standard error: a PATH that is not there, a configuration file that cannot be used, nothing piped in for \-, or a command that failed (datui formats check on a spec with errors).
.TP
\fB2\fR
A usage error: an unknown option or command, or a value an option does not take.
.SH ENVIRONMENT
.TP
\fBDATUI_CONFIG_DIR\fR
The config directory, in place of the platform's (\fB~/.config/datui\fR on Linux). Saved views and format specs live there too.
.SH FILES
\fICONFIG\fR is \fB$DATUI_CONFIG_DIR\fR when it is set, else \fB$XDG_CONFIG_HOME/datui\fR (\fB~/.config/datui\fR) on Linux, \fB~/Library/Application Support/datui\fR on macOS and \fB%APPDATA%\edatui\fR on Windows.
.TP
\fICONFIG\fR/config.toml
The config file: see datui-config(5). \fBdatui config path\fR prints the files read.
.TP
\fICONFIG\fR/catalog.toml
Your catalog, which Ctrl+D on the home screen adds to: see datui-catalog(1).
.TP
\fICONFIG\fR/catalogs/
More catalogs, one *.toml each, named by its file; examples.toml replaces the bundled one.
.TP
\fICONFIG\fR/views/
Saved views: see datui-views(1).
.TP
\fICONFIG\fR/formats/
Format specs and dictionaries, searched first: see datui-formats(7).
.SH EXAMPLES
Print the catalog datui ships, the worked example of the format.
.PP
.RS 4
.EX
datui catalog show examples
.EE
.RE
.PP
List the catalogs: id, label, datasets and file.
.PP
.RS 4
.EX
datui catalog show
.EE
.RE
.PP
Check a catalog file and list its datasets.
.PP
\fBteam.toml\fR
.PP
.RS 4
.EX
label = "Team data"
[orders]
name = "Orders"
path = "data/orders.parquet"
description = "Every order, one row each"
columns.status = { description = "Where the order is", values = { P = "Placed", S = "Shipped" } }
.EE
.RE
.PP
.RS 4
.EX
datui catalog check team.toml
.EE
.RE
.SH "SEE ALSO"
\fBdatui\fR(1), \fBdatui\-config\fR(5)
.PP
The datui documentation: <https:/\:/\:derekwisong.\:github.\:io/\:datui/\:>
.SH BUGS
Report bugs at <https:/\:/\:github.\:com/\:derekwisong/\:datui/\:issues>.
.SH AUTHORS
Derek Wisong and the datui contributors.
.SH COPYRIGHT
Copyright \(co 2026 Derek Wisong
.PP
datui is free software under the MIT License.