Skip to content

TingjiaInFuture/pixrep

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

33 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

pixrep logo pixrep

πŸ“‰ SAVE UP TO 90% TOKENS

Turn Codebases into Visual Context for Multimodal LLMs

PyPI version License: MIT GitHub Stars


πŸ“– Introduction

pixrep is a developer tool designed to bridge the gap between large code repositories and Multimodal Large Language Models.

Instead of feeding raw text that consumes massive context windows, pixrep converts your repository into a structured, hierarchical set of PDFs. This allows you to:

  • Save 90% Tokens: Visual encoding is far more efficient than text tokenization.
  • Test for Free: Easily share your entire codebase with premium models (like Claude Opus 4.6) on platforms like arena.ai without hitting text limits.

πŸš€ Why Visual Code?

Traditional text tokenization is expensive. Visual encoding compresses structure efficiently.

Comparison in Google AI Studio (Gemini 3 Pro):

Raw Files (Text Input) pixrep OnePDF (Visual Input)
Raw Files Usage OnePDF Usage
31,812 Tokens ❌
(Cluttered context)
19,041 Tokens βœ…
(Clean, single file)

πŸŽ“ Academic Backing

The core philosophy of pixrep (rendering code β†’ PDF with syntax highlighting + heatmaps) has been validated by top-tier papers from 2025–2026:

  • Text or Pixels? It Takes Half (arXiv:2510.18279): Rendering text as images saves ~50% decoder tokens while maintaining or improving performance.
  • DeepSeek-OCR (arXiv:2510.18234): Visual encoding achieves 10–20Γ— compression ratios for dense, structured text.
  • CodeOCR (arXiv:2602.01785, Feb 2026): A code-specific study showing that visual input with syntax highlighting improves performance even at 4Γ— compression. In tasks like clone detection, the visual approach outperforms plain text.

Verdict: In the multimodal era, the optimal way to feed code is via "visual perception" rather than "text reading."

✨ Features

  • πŸ“‰ High Efficiency: Drastically reduces context window usage for large repos.
  • ⚑ Faster Scanning: Single-pass file loading (binary check + line count + optional content decode) to reduce I/O overhead.
  • 🎨 Syntax Highlighting: Supports 50+ languages (Python, JS, Rust, Go, C++, etc.) with a "One Dark" inspired theme.
  • 🧠 Semantic Minimap: Auto-generates per-file micro UML / call graph summaries to expose structure at a glance.
  • πŸ”₯ Linter Heatmap: Integrates ruff / eslint findings and marks risky lines with red/yellow visual overlays.
  • πŸ”Ž Query Mode: Search by text or semantic symbols, then render only matched snippets to PDF/PNG.
  • πŸ—‚οΈ Hierarchical Output: Generates a clean 00_INDEX.pdf summary and separate files for granular access.
  • 🌏 CJK Support: Built-in font fallback for Chinese/Japanese/Korean characters (Auto-detects OS fonts).
  • πŸ›‘οΈ Smart Filtering: Respects .gitignore patterns and supports custom ignore rules.
  • πŸ“Š Insightful Stats: Calculates line counts and language distribution automatically.
  • 🧾 Scan Diagnostics: Prints scan summary (seen/loaded/ignored/binary/errors) for faster troubleshooting.

πŸ“¦ Installation

pip install pixrep

For PNG output support (--format png), install optional extras:

pip install "pixrep[png]"

πŸ› οΈ Usage

Quick Start

Convert the current directory to hierarchial PDFs in ./pixrep_output/<repo_name>:

pixrep .

Or pack everything into a single, token-optimized PDF (Recommended for LLMs):

pixrep onepdf .

Common Commands

Generate PDFs for a specific repo:

pixrep generate /path/to/my-project -o ./my-project-pdfs

Pack core code into a single minimized PDF (all-in-one):

pixrep onepdf /path/to/my-project -o ./ONEPDF_CORE.pdf

Notes:

  • Defaults to git ls-files (tracked files) when available.
  • Defaults to "core-only" filtering (skips docs/tests); use --no-core-only to include them.

Preview structure and stats (without generating PDFs):

pixrep list /path/to/my-project

list mode now uses lightweight scanning (no file content decode), so large repos respond significantly faster.

Show only top 5 languages in the summary:

pixrep list . --top-languages 5

Query and render only matching snippets:

pixrep query . -q "cache" --glob "*.py" --format png

Semantic query (Python symbols) with interactive terminal preview:

pixrep query . -q "CodeInsight" --semantic --tui

CLI Reference

Argument Description Default
repo Path to the code repository. . (Current Dir)
-o, --output Directory to save the generated PDFs. ./pixrep_output/<repo>
--max-size Max file size to process (in KB). Files larger than this are skipped. 512 KB
--ignore Additional glob patterns to ignore (e.g., *.json test/*). []
--index-only Generate only the 00_INDEX.pdf (Directory tree & stats). False
--disable-semantic-minimap Turn off per-file semantic UML/callgraph panel. False
--disable-lint-heatmap Turn off linter-based line heatmap background. False
--linter-timeout Timeout seconds for each linter command. 20
--list-only Print the directory tree and stats to console, then exit. False
-V, --version Show version information. -

βš™οΈ Performance Notes

pixrep now applies two execution paths:

  1. Light scan path (pixrep list, pixrep generate --index-only, --list-only): only metadata and line counts are collected; file content is not loaded.
  2. Full scan path (regular pixrep generate): file content is decoded only when needed for PDF rendering.

This reduces memory pressure and disk I/O for repository exploration workflows.

Lint/semantic caches are now stored in user cache directories by default:

  • Windows: %LOCALAPPDATA%/pixrep/cache/<repo_name>
  • Linux/macOS: $XDG_CACHE_HOME/pixrep/<repo_name> or ~/.cache/pixrep/<repo_name>

You can override with PIXREP_CACHE_DIR.

πŸ“‚ Output Structure

After running pixrep ., you will get a folder structure optimized for LLM upload:

pixrep_output/pixrep/
β”œβ”€β”€ 00_INDEX.pdf             # <--- Upload this first! Contains tree & stats
β”œβ”€β”€ 001_LICENSE.pdf
β”œβ”€β”€ 002_README.md.pdf
β”œβ”€β”€ 003_pixrep___init__.py.pdf
β”œβ”€β”€ 005_pixrep_cli.py.pdf
└── ...

🧩 Supported Languages

pixrep automatically detects and highlights syntax for:

  • Core: Python, C, C++, Java, Rust, Go
  • Web: HTML, CSS, JavaScript, TypeScript, Vue, Svelte
  • Config: JSON, YAML, TOML, XML, Dockerfile, Ini
  • Scripting: Bash, Lua, Perl, Ruby, PHP
  • And more: Swift, Kotlin, Scala, Haskell, OCaml, etc.

🀝 Contributing

We welcome contributions! Please feel free to submit a Pull Request.

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

πŸ“„ License

Distributed under the MIT License. See LICENSE for more information.