datui_cli/
lib.rs

1//! Shared CLI definitions for datui.
2//!
3//! Used by the main application and by the build script (manpage) and
4//! gen_docs binary (command-line-options markdown).
5
6use clap::{CommandFactory, Parser, ValueEnum};
7use std::path::Path;
8
9/// File format for data files (used to bypass extension-based detection).
10/// When `--format` is not specified, format is auto-detected from the file extension.
11#[derive(Debug, Clone, Copy, ValueEnum, PartialEq, Eq)]
12pub enum FileFormat {
13    /// Parquet columnar format
14    Parquet,
15    /// Comma-separated values
16    Csv,
17    /// Tab-separated values
18    Tsv,
19    /// Pipe-separated values
20    Psv,
21    /// JSON array format
22    Json,
23    /// JSON Lines / NDJSON (one JSON object per line)
24    Jsonl,
25    /// Arrow IPC / Feather
26    Arrow,
27    /// Avro row format
28    Avro,
29    /// ORC columnar format
30    Orc,
31    /// Excel (.xls, .xlsx, .xlsm, .xlsb)
32    Excel,
33}
34
35impl FileFormat {
36    /// Detect file format from path extension. Returns None when extension is missing or unknown.
37    pub fn from_path(path: &Path) -> Option<Self> {
38        path.extension()
39            .and_then(|e| e.to_str())
40            .and_then(Self::from_extension)
41    }
42
43    /// Parse format from extension string (e.g. "parquet", "csv").
44    pub fn from_extension(ext: &str) -> Option<Self> {
45        match ext.to_lowercase().as_str() {
46            "parquet" => Some(Self::Parquet),
47            "csv" => Some(Self::Csv),
48            "tsv" => Some(Self::Tsv),
49            "psv" => Some(Self::Psv),
50            "json" => Some(Self::Json),
51            "jsonl" | "ndjson" => Some(Self::Jsonl),
52            "arrow" | "ipc" | "feather" => Some(Self::Arrow),
53            "avro" => Some(Self::Avro),
54            "orc" => Some(Self::Orc),
55            "xls" | "xlsx" | "xlsm" | "xlsb" => Some(Self::Excel),
56            _ => None,
57        }
58    }
59}
60
61/// Compression format for data files
62#[derive(Debug, Clone, Copy, ValueEnum, PartialEq, Eq)]
63pub enum CompressionFormat {
64    /// Gzip compression (.gz) - Most common, good balance of speed and compression
65    Gzip,
66    /// Zstandard compression (.zst) - Modern, fast compression with good ratios
67    Zstd,
68    /// Bzip2 compression (.bz2) - Good compression ratio, slower than gzip
69    Bzip2,
70    /// XZ compression (.xz) - Excellent compression ratio, slower than bzip2
71    Xz,
72}
73
74impl CompressionFormat {
75    /// Detect compression format from file extension
76    pub fn from_extension(path: &Path) -> Option<Self> {
77        if let Some(ext) = path.extension().and_then(|e| e.to_str()) {
78            match ext.to_lowercase().as_str() {
79                "gz" => Some(Self::Gzip),
80                "zst" | "zstd" => Some(Self::Zstd),
81                "bz2" | "bz" => Some(Self::Bzip2),
82                "xz" => Some(Self::Xz),
83                _ => None,
84            }
85        } else {
86            None
87        }
88    }
89
90    /// Get file extension for this compression format
91    pub fn extension(&self) -> &'static str {
92        match self {
93            Self::Gzip => "gz",
94            Self::Zstd => "zst",
95            Self::Bzip2 => "bz2",
96            Self::Xz => "xz",
97        }
98    }
99}
100
101/// Command-line arguments for datui
102#[derive(Clone, Parser, Debug)]
103#[command(
104    name = "datui",
105    version,
106    about = "Data Exploration in the Terminal",
107    long_about = include_str!("../long_about.txt")
108)]
109pub struct Args {
110    /// Path(s) to the data file(s) to open.
111    /// Multiple files of the same format are concatenated into one table (not required with --generate-config, --clear-cache, or --remove-templates)
112    #[arg(required_unless_present_any = ["generate_config", "clear_cache", "remove_templates"], num_args = 1.., value_name = "PATH")]
113    pub paths: Vec<std::path::PathBuf>,
114
115    /// Skip this many lines when reading a file
116    #[arg(long = "skip-lines")]
117    pub skip_lines: Option<usize>,
118
119    /// Skip this many rows when reading a file
120    #[arg(long = "skip-rows")]
121    pub skip_rows: Option<usize>,
122
123    /// Skip this many rows at the end of the file (e.g. to ignore vendor footer or trailing garbage)
124    #[arg(long = "skip-tail-rows", value_name = "N")]
125    pub skip_tail_rows: Option<usize>,
126
127    /// Specify that the file has no header
128    #[arg(long = "no-header")]
129    pub no_header: Option<bool>,
130
131    /// Specify the delimiter to use when reading a delimited text file
132    #[arg(long = "delimiter")]
133    pub delimiter: Option<u8>,
134
135    /// Number of rows to use when inferring CSV schema (default: 1000). Larger values reduce risk of wrong type (e.g. int then N/A).
136    #[arg(long = "infer-schema-length", value_name = "N")]
137    pub infer_schema_length: Option<usize>,
138
139    /// When reading CSV, ignore parse errors and continue with the next batch (default: false)
140    #[arg(long = "ignore-errors", value_name = "BOOL", value_parser = clap::value_parser!(bool))]
141    pub ignore_errors: Option<bool>,
142
143    /// Treat these values as null when reading CSV. Use once per value; no "=" means all columns, COL=VAL means column COL only (first "=" separates column from value). Example: --null-value NA --null-value amount=
144    #[arg(long = "null-value", value_name = "VAL")]
145    pub null_value: Vec<String>,
146
147    /// Specify the compression format explicitly (gzip, zstd, bzip2, xz)
148    /// If not specified, compression is auto-detected from file extension.
149    #[arg(long = "compression", value_enum)]
150    pub compression: Option<CompressionFormat>,
151
152    /// Force file format (parquet, csv, tsv, psv, json, jsonl, arrow, avro, orc, excel).
153    /// By default format is auto-detected from the file extension. Use this for URLs or paths without an extension.
154    #[arg(long = "format", value_enum)]
155    pub format: Option<FileFormat>,
156
157    /// Enable debug mode to show operational information
158    #[arg(long = "debug", action)]
159    pub debug: bool,
160
161    /// Enable Hive-style partitioning for directory or glob paths; ignored for a single file
162    #[arg(long = "hive", action)]
163    pub hive: bool,
164
165    /// Infer Hive/partitioned Parquet schema from one file for faster load (default: true). Set to false to use full schema scan.
166    #[arg(long = "single-spine-schema", value_name = "BOOL", value_parser = clap::value_parser!(bool))]
167    pub single_spine_schema: Option<bool>,
168
169    /// Try to parse CSV string columns as dates (e.g. YYYY-MM-DD, ISO datetime). Default: true
170    #[arg(long = "parse-dates", value_name = "BOOL", value_parser = clap::value_parser!(bool))]
171    pub parse_dates: Option<bool>,
172
173    /// Trim whitespace and parse CSV string columns as date, datetime, time, duration, int, or float. Default: applied to all string columns. Use --parse-strings=COL (repeatable) to limit to specific columns, or --no-parse-strings to disable.
174    #[arg(long = "parse-strings", value_name = "COL", num_args = 0.., default_missing_value = "")]
175    pub parse_strings: Vec<String>,
176
177    /// Disable parse-strings for CSV (trim and type inference). Overrides config and default.
178    #[arg(long = "no-parse-strings", action)]
179    pub no_parse_strings: bool,
180
181    /// Decompress into memory. Default: decompress to temp file and use lazy scan
182    #[arg(long = "decompress-in-memory", default_missing_value = "true", num_args = 0..=1, value_parser = clap::value_parser!(bool))]
183    pub decompress_in_memory: Option<bool>,
184
185    /// Directory for decompression temp files (default: system temp, e.g. TMPDIR)
186    #[arg(long = "temp-dir", value_name = "DIR")]
187    pub temp_dir: Option<std::path::PathBuf>,
188
189    /// Excel sheet to load: 0-based index (e.g. 0) or sheet name (e.g. "Sales")
190    #[arg(long = "sheet", value_name = "SHEET")]
191    pub excel_sheet: Option<String>,
192
193    /// Clear all cache data and exit
194    #[arg(long = "clear-cache", action)]
195    pub clear_cache: bool,
196
197    /// Apply a template by name when starting the application
198    #[arg(long = "template")]
199    pub template: Option<String>,
200
201    /// Remove all templates and exit
202    #[arg(long = "remove-templates", action)]
203    pub remove_templates: bool,
204
205    /// When set, datasets with this many or more rows are sampled for analysis (faster, less memory).
206    /// Overrides config [performance] sampling_threshold. Use 0 to disable sampling (full dataset) for this run.
207    /// When omitted, config or full-dataset mode is used.
208    #[arg(long = "sampling-threshold", value_name = "N")]
209    pub sampling_threshold: Option<usize>,
210
211    /// Use Polars streaming engine for LazyFrame collect when available (default: true). Set to false to disable.
212    #[arg(long = "polars-streaming", value_name = "BOOL", value_parser = clap::value_parser!(bool))]
213    pub polars_streaming: Option<bool>,
214
215    /// Apply workaround for Polars 0.52 pivot with Date/Datetime index (default: true). Set to false to test without it.
216    #[arg(long = "workaround-pivot-date-index", value_name = "BOOL", value_parser = clap::value_parser!(bool))]
217    pub workaround_pivot_date_index: Option<bool>,
218
219    /// Number of pages to buffer ahead of the visible area (default: 3)
220    /// Larger values provide smoother scrolling but use more memory
221    #[arg(long = "pages-lookahead")]
222    pub pages_lookahead: Option<usize>,
223
224    /// Number of pages to buffer behind the visible area (default: 3)
225    /// Larger values provide smoother scrolling but use more memory
226    #[arg(long = "pages-lookback")]
227    pub pages_lookback: Option<usize>,
228
229    /// Display row numbers on the left side of the table
230    #[arg(long = "row-numbers", action)]
231    pub row_numbers: bool,
232
233    /// Starting index for row numbers (default: 1)
234    #[arg(long = "row-start-index")]
235    pub row_start_index: Option<usize>,
236
237    /// Colorize main table cells by column type (default: true). Set to false to disable.
238    #[arg(long = "column-colors", value_name = "BOOL", value_parser = clap::value_parser!(bool))]
239    pub column_colors: Option<bool>,
240
241    /// Generate default configuration file at ~/.config/datui/config.toml
242    #[arg(long = "generate-config", action)]
243    pub generate_config: bool,
244
245    /// Force overwrite existing config file when using --generate-config
246    #[arg(long = "force", requires = "generate_config", action)]
247    pub force: bool,
248
249    /// S3-compatible endpoint URL (overrides config and AWS_ENDPOINT_URL). Example: http://localhost:9000
250    #[arg(long = "s3-endpoint-url", value_name = "URL")]
251    pub s3_endpoint_url: Option<String>,
252
253    /// S3 access key (overrides config and AWS_ACCESS_KEY_ID)
254    #[arg(long = "s3-access-key-id", value_name = "KEY")]
255    pub s3_access_key_id: Option<String>,
256
257    /// S3 secret key (overrides config and AWS_SECRET_ACCESS_KEY)
258    #[arg(long = "s3-secret-access-key", value_name = "SECRET")]
259    pub s3_secret_access_key: Option<String>,
260
261    /// S3 region (overrides config and AWS_REGION). Example: us-east-1
262    #[arg(long = "s3-region", value_name = "REGION")]
263    pub s3_region: Option<String>,
264}
265
266/// Escape `|` and newlines for use in markdown table cells.
267fn escape_table_cell(s: &str) -> String {
268    s.replace('|', "\\|").replace(['\n', '\r'], " ")
269}
270
271/// Render command-line options as markdown.
272///
273/// Used by the gen_docs binary; output is written to stdout and then
274/// to `docs/reference/command-line-options.md` by the docs build process.
275pub fn render_options_markdown() -> String {
276    let mut cmd = Args::command();
277    cmd.build();
278
279    let mut out = String::from("# Command Line Options\n\n");
280
281    out.push_str("## Usage\n\n```\n");
282    let usage = cmd.render_usage();
283    out.push_str(&usage.to_string());
284    out.push_str("\n```\n\n");
285
286    out.push_str("## Options\n\n");
287    out.push_str("| Option | Description |\n");
288    out.push_str("|--------|-------------|\n");
289
290    for arg in cmd.get_arguments() {
291        let id = arg.get_id().as_ref().to_string();
292        if id == "help" || id == "version" {
293            continue;
294        }
295
296        let option_str = if arg.is_positional() {
297            let placeholder: String = arg
298                .get_value_names()
299                .map(|names| {
300                    names
301                        .iter()
302                        .map(|n: &clap::builder::Str| format!("<{}>", n.as_ref() as &str))
303                        .collect::<Vec<_>>()
304                        .join(" ")
305                })
306                .unwrap_or_default();
307            if arg.is_required_set() {
308                placeholder
309            } else {
310                format!("[{placeholder}]")
311            }
312        } else {
313            let mut parts = Vec::new();
314            if let Some(s) = arg.get_short() {
315                parts.push(format!("-{s}"));
316            }
317            if let Some(l) = arg.get_long() {
318                parts.push(format!("--{l}"));
319            }
320            let op = parts.join(", ");
321            let takes_val = arg.get_action().takes_values();
322            let placeholder: String = if takes_val {
323                arg.get_value_names()
324                    .map(|names| {
325                        names
326                            .iter()
327                            .map(|n: &clap::builder::Str| format!("<{}>", n.as_ref() as &str))
328                            .collect::<Vec<_>>()
329                            .join(" ")
330                    })
331                    .unwrap_or_default()
332            } else {
333                String::new()
334            };
335            if placeholder.is_empty() {
336                op
337            } else {
338                format!("{op} {placeholder}")
339            }
340        };
341
342        let help = arg
343            .get_help()
344            .map(|h| escape_table_cell(&h.to_string()))
345            .unwrap_or_else(|| "-".to_string());
346
347        out.push_str(&format!("| `{option_str}` | {help} |\n"));
348    }
349
350    out
351}
352
353#[cfg(test)]
354mod tests {
355    use super::*;
356
357    #[test]
358    fn test_compression_detection() {
359        assert_eq!(
360            CompressionFormat::from_extension(Path::new("file.csv.gz")),
361            Some(CompressionFormat::Gzip)
362        );
363        assert_eq!(
364            CompressionFormat::from_extension(Path::new("file.csv.zst")),
365            Some(CompressionFormat::Zstd)
366        );
367        assert_eq!(
368            CompressionFormat::from_extension(Path::new("file.csv.bz2")),
369            Some(CompressionFormat::Bzip2)
370        );
371        assert_eq!(
372            CompressionFormat::from_extension(Path::new("file.csv.xz")),
373            Some(CompressionFormat::Xz)
374        );
375        assert_eq!(
376            CompressionFormat::from_extension(Path::new("file.csv")),
377            None
378        );
379        assert_eq!(CompressionFormat::from_extension(Path::new("file")), None);
380    }
381
382    #[test]
383    fn test_compression_extension() {
384        assert_eq!(CompressionFormat::Gzip.extension(), "gz");
385        assert_eq!(CompressionFormat::Zstd.extension(), "zst");
386        assert_eq!(CompressionFormat::Bzip2.extension(), "bz2");
387        assert_eq!(CompressionFormat::Xz.extension(), "xz");
388    }
389
390    #[test]
391    fn test_file_format_from_path() {
392        assert_eq!(
393            FileFormat::from_path(Path::new("data.parquet")),
394            Some(FileFormat::Parquet)
395        );
396        assert_eq!(
397            FileFormat::from_path(Path::new("data.csv")),
398            Some(FileFormat::Csv)
399        );
400        assert_eq!(
401            FileFormat::from_path(Path::new("file.jsonl")),
402            Some(FileFormat::Jsonl)
403        );
404        assert_eq!(FileFormat::from_path(Path::new("noext")), None);
405        assert_eq!(
406            FileFormat::from_path(Path::new("file.NDJSON")),
407            Some(FileFormat::Jsonl)
408        );
409    }
410}
datui_cli/lib.rs

datui_cli/
lib.rs
