yoinky 1.2.0

Pack your codebase into a single markdown file for LLM context, with comment stripping, secret masking, and dependency trees.

Yoink

Yoink is a command-line tool and FastAPI backend designed to bundle, sanitize, and visualize codebases for Large Language Model (LLM) contexts. It converts raw project directories into structured Markdown documents, optimizing token consumption and preventing compliance and security leaks.

---

Features

• Token Shredder: Safely strips comments, docstrings, and excess whitespace to reduce prompt size.
• Secret Shield: Programmatically redacts credentials, private keys, emails, and IP addresses.
• Compliance Stripper: Replaces corporate endpoints or proprietary trademarks with generic labels.
• Dependency Trees: Automatically generates AST-based ASCII dependency trees and Mermaid flowcharts.

---

Installation

Install from PyPI:

pip install yoinky

Or install locally in editable mode:

git clone https://github.com/Asifdotexe/yoink.git
cd yoink
pip install -e .

---

Documentation

For detailed instructions and references, please refer to the dedicated guides:

• CLI Usage Guide: Complete reference of CLI commands, flags (--raw, --max-size, --no-visualize, etc.), and usage examples.
• REST API Guide: Detailed guide to API endpoints, schema structures, and Render blueprint web service deployment.
• Token Reduction Learnings: Technical reference on how BPE tokenizers handle whitespace, license header stripping, and performance tuning.

---

Running Tests

Verify your local installation:

pytest

---

License

This project is licensed under the GNU AGPLv3 License.