CLI Overview
The alimentar command-line interface provides tools for data inspection, transformation, and management.
Installation
The CLI is included when you install alimentar with the cli feature (enabled by default):
cargo install alimentar
Or build from source:
cargo build --release --features cli
Commands
| Command | Description |
|---|---|
info | Display dataset information (schema, row count, file size) |
head | Display first N rows of a dataset |
schema | Display dataset schema in detail |
view | Interactive TUI viewer for exploring datasets |
convert | Convert between data formats |
registry | Dataset registry operations |
Quick Examples
# Inspect a dataset
alimentar info data.parquet
alimentar head data.parquet -n 10
alimentar schema data.parquet
# Interactive exploration
alimentar view data.parquet
alimentar view data.csv --search "error"
# Format conversion
alimentar convert data.csv data.parquet
alimentar convert data.parquet data.json
Global Options
| Option | Description |
|---|---|
-h, --help | Print help information |
-V, --version | Print version information |
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Invalid arguments |
| 3 | File not found |
| 4 | Quality check failed |
Supported Formats
The CLI supports the following data formats:
- Parquet (
.parquet) - Columnar storage format - Arrow IPC (
.arrow,.ipc) - Arrow's native format - CSV (
.csv) - Comma-separated values - JSON/JSONL (
.json,.jsonl) - JSON and newline-delimited JSON