Lume 🕯️

Lume is a sleek, modern JSON viewer CLI built for developers who need a better way to explore API responses and local data. It transforms raw JSON into interactive, navigable TUI experiences with a premium aesthetic.

Features

• Interactive Tree View: Browse complex nested structures with a navigable tree.
• Elegant Box View: A card-based layout for quick scanning of large datasets.
• CURL-like Fetching: Support for custom methods (-X), headers (-H), and data (-d).
• Fast & Async: Built on high-performance libraries to handle large responses without freezing.

Installation

Local Global Install (Recommended)

If you want to use lume or lumeview globally in your terminal while developing, run this inside the project directory:

uv tool install .

This will install the package and make both the lume and lumeview commands available.

From PyPI (Coming Soon)

Once published, you'll be able to install it using the package name lumeview:

pip install lumeview
# or
uv tool install lumeview

Development

If you just want to run it without installing:

uv sync
uv run lume --help

Usage

Fetch from an API

lume fetch 'https://api.example.com/data' -X POST -d '{"query": "test"}'

Open a local file

lume open test.json --display box

Built With

• Textual - TUI Framework.
• Rich - Terminal formatting and rendering.
• Click - CLI argument parsing.
• HTTPX - Modern, async HTTP client.
• UV - Extremely fast Python package manager.