Ziplex

Ziplex

**English** | [한국어](README_ko.md)

**Turn any local project into a context file an AI can load instantly — instead of reading through hundreds of raw files.**

Ziplex walks a project, compresses and structures it with Tree-sitter, summarizes it with an LLM (optional — see [Quick start](#quick-start) for the no-API-key path), and lets a human correct the result before it ships. The output is `aif.json`: a small, structured "AI context format" file.

⚠️ Under active development. Interfaces and output format may still change.

---

Where it helps

• Giving an AI assistant your project's shape once, not every session — paste aif.json into a chat, point an MCP client at it, or open it in the GUI, instead of re-explaining file layout and conventions every time.
• Multi-language projects — a TypeScript frontend, a Python or Java backend, config and docs in between: one pack covers all of it, with cross-file relationships intact.
• Game modding and asset projects that aren't git repos — a Godot scene referencing a GDScript/Lua script by path, a Lua mod with loose asset files: Ziplex tracks those relationships even for files with no Tree-sitter grammar of their own (see Features).
• Onboarding an AI onto a codebase you didn't write — summaries are human-reviewed before they ship, so you're not trusting a raw LLM guess about unfamiliar code.
• Keeping a CI context budget honest — --max-tokens fails a build if the packed payload grows past what a target model can hold.
• Sharing one AI context across a team — aif.json/detail.json are just files; commit them like any other generated artifact (see Team use).

Quick start

pip install ziplex        # or: venv\Scripts\activate && pip install -e . from a clone

**Try it right now — no API key, no signup, no network call:**

ziplex pack ./your-project/ --auto --no-llm

This runs the full pipeline (Tree-sitter compression, depe