peek-cli 0.1.1

A lightning-fast CLI for inspecting CSVs and datasets in the terminal.

Peek ⚡

Stop spinning up Jupyter just to check a CSV.

Peek is a blazing fast CLI for data inspection. It is built for developers who live in SSH sessions, hate waiting for heavy IDEs to load, and need to sanity-check a 5GB dataset now.

---

🚀 The Features

• ⚡ Zero-RAM Overhead: Powered by Polars LazyFrames (Rust). Scan multi-gigabyte files instantly without crashing your terminal.
• 🧠 Heuristic Intelligence: Automatically detects critical issues like high null rates, constant columns, and potential primary keys.
• 📊 ASCII Visuals: Render Histograms and Scatter plots directly in the CLI.

---

🛠️ Usage

1. View Data

Instantly peek at the head or tail of your dataset.

# View top 10 rows
peek view data.csv

# View the last 5 rows
peek view data.csv --tail --rows 5

2. Health Check (describe)

Get a comprehensive health report with smart warnings (missing data, constants, unique counts).

peek describe data.csv

Output includes: Missing value %, Type inference, and automated quality warnings.

3. Visualizations (plot)

Visualize distributions and correlations without leaving the terminal.

Histogram / Bar Chart (Single Column)

peek plot data.csv --col category

Scatter Plot (Two Columns)

peek plot data.csv --col price --y-col rating --title "Price vs Rating"

4. NLP (sentiment)

Scan a text column to view sentiment distribution (Positive/Neutral/Negative) using VADER.

peek sentiment reviews.csv --col review_text

Output: Average sentiment score and a terminal-based distribution chart.

---

🏗️ Tech Stack

• Polars: The high-performance Rust-based DataFrame engine.
• Typer: For building the robust CLI interface.
• Rich: For beautiful tables, panels, and terminal formatting.
• Plotext: For rendering graphs directly in the terminal.
• UV: Blazing fast Python package management.