@xynogen/pix-read0.4.3

Pi tool — file read with syntax highlight

GitHub Actions Published 14 days ago MIT ~1.1K downloads/mo

Untested on omp

This is a pi package. No one has reported whether it works on omp yet. If you try it, add your result below.

Reports 0

No reports yet.

Readme

pix-read

Pi tool — file read with syntax highlighting.

What it does

Replaces Pi's default read tool with an enhanced version backed by pix-pretty. File content is syntax-highlighted using cli-highlight (highlight.js-backed) with language auto-detection. The call label shows the shortened file path, with optional from line N and (N lines) hints. Images are displayed with mime type and byte size and a type icon. Long files are shown with a line count and truncation notice; expanded mode reveals the full content. Depends on @xynogen/pix-pretty, installed automatically as a dependency.

Auto-collapse

After a configurable delay (default 10 seconds), completed output collapses to a row such as ✓ read src/index.ts · 120 lines. Structured failures use a compact ✗ row after the delay. Expanding recomputes and restores the normal bounded preview or exact diagnostic without restarting the elapsed timer. This is controlled via the collapse section of ~/.pi/agent/pix.json:

{
  "collapse": {
    "enabled": true,
    "delaySec": 10,
    "tools": { "read": true }
  }
}

Set collapse.tools.read: false to disable for this tool only. See @xynogen/pix-runtime/collapse for the full API.

Install

pi install npm:@xynogen/pix-read

Bundled in @xynogen/pix-core. Install it alone only if you do not use pix-core.

Full distro

This package is part of Pix. The installer sets up Pi and the full distro. See Install for the notes for each OS.

# Linux / macOS
curl -fsSL https://raw.githubusercontent.com/xynogen/pix-mono/main/scripts/install.sh | sh

# Windows
irm https://raw.githubusercontent.com/xynogen/pix-mono/main/scripts/install.ps1 | iex

License

MIT