Skip to main content

Pack your codebase into a single formatted Markdown string for LLMs.

Project description

📦 ai-pack

Python Version License PyPI version GitHub Stars

Pack your entire codebase, specific files, or uncommitted changes into a single token-optimized Markdown prompt for LLMs (like ChatGPT, Claude, Gemini).


[!IMPORTANT] 📋 Default Clipboard Behavior

By default, running aip automatically copies the generated Markdown payload directly to your system clipboard. No files are saved to disk unless you specify the output file using the -o or --output flag.

Note: It also natively supports remote SSH sessions using the OSC 52 clipboard escape sequence.


⚡ Key Features

  • 📋 Clipboard-First: Automatically copies your prompt, ready to paste straight into ChatGPT, Claude, Gemini, or any LLM interface.
  • 💀 Skeleton Mode (-s / --skeleton): Drastically saves tokens by stripping function/method bodies, keeping only class structures, signatures, and imports.
  • 🎯 Interactive Selector (-i): Choose files interactively via checkbox CLI menu.
  • 🌿 Git-Aware (-c / --changed): Automatically pack only modified, staged, or untracked files.
  • 🛡️ Gitignore-Respecting: Excludes ignored, temporary, or build files automatically (using git ls-files with manual fallback for non-git folders).
  • 💬 Prompt Presets (-p): Instantly prepend pre-configured prompts for code review, bug hunting, or architecture explanations.
  • 📊 Token Estimation: Heuristic token counting warns you if your payload exceeds your limit (--max-tokens).

🚀 Quick Start

Installation

Choose your preferred installation method:

# Option 1: Install official package via pip (Recommended)
pip3 install ai-pack-cli --user

# Option 2: Install via pipx (Isolated environment)
pipx install ai-pack-cli

# Option 3: Standalone Executable (Zero dependencies - No Python required!)
# Linux:
curl -sSL https://github.com/iamraydoan/ai-pack/releases/latest/download/ai-pack-linux-x86_64 -o /usr/local/bin/aip && chmod +x /usr/local/bin/aip

# macOS:
curl -sSL https://github.com/iamraydoan/ai-pack/releases/latest/download/ai-pack-macos-arm64 -o /usr/local/bin/aip && chmod +x /usr/local/bin/aip

# Windows: Download ai-pack-windows-x86_64.exe from GitHub Releases

[!TIP] Skeleton Mode (-s / --skeleton): Natively supports AST outline extraction for Python, JavaScript, TypeScript, Go, Rust, Java, C/C++, C#, PHP, Ruby, and 30+ programming languages out of the box with zero external setup required.


💡 Usage & Common Scenarios

Here are common ways to use ai-pack (using commands aip, ai-pack, or aipack):

1. Pack codebase & copy to clipboard (Default)

aip

2. Pack specific files/folders and save to a file

aip -f src/main.py tests/ -o output.md

3. Pack only uncommitted changes with a code review prompt

aip -c -p review

4. Pack code skeleton to save context window tokens

aip -s -p explain

5. Choose files interactively before packing

aip -i

⚙️ CLI Flags & Interactions

Reference

Flag Short Type Description
--files -f Path(s) Specific files or directories to pack (space-separated).
--changed -c Flag Pack only modified, staged, or untracked Git files.
--interactive -i Flag Select files interactively via a checkbox menu.
--skeleton -s Flag Strip method bodies, leaving only signatures and imports to save tokens.
--prompt -p Choices Prepend preset: review, bug, or explain.
--output -o Path Save output directly to a file instead of copying to clipboard.
--max-tokens Number Count approximate tokens and warn if the limit is exceeded.

🤝 Combining Flags

You can combine flags to narrow down and customize your payload:

  • Filter Git changes (-f + -c / --changed): Only packs files that are both modified/uncommitted AND located inside the specified paths.
    aip -c -f src/
    
  • Interactive selection with filter (-i + -f / -c): Shows only the filtered list (e.g. only changed files) in the interactive checkbox menu instead of the entire repo.
    aip -i -c
    
  • Structure only (-s / --skeleton + any mode): Can be appended to any command to extract skeletons instead of full source code for the selected files.
    aip -i -s
    
  • Redirect output (-o vs Default): By default, everything goes to the clipboard. Use -o filename.md to save to a file instead.

💀 Skeleton Mode Example

Original Code:

def fibonacci(n):
    if n <= 0:
        return []
    elif n == 1:
        return [0]
    sequence = [0, 1]
    while len(sequence) < n:
        sequence.append(sequence[-1] + sequence[-2])
    return sequence

Skeleton Output:

def fibonacci(n): ...

🤝 Contributing

Contributions are welcome! Please check out the Developer & Contributing Guide for local setup, running unit tests, and code formatting guidelines (ruff).

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

Give this repository a ⭐ if it helped you pack your code for LLMs!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_pack_cli-0.2.2.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_pack_cli-0.2.2-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file ai_pack_cli-0.2.2.tar.gz.

File metadata

  • Download URL: ai_pack_cli-0.2.2.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for ai_pack_cli-0.2.2.tar.gz
Algorithm Hash digest
SHA256 5fe5ff9a21a5d05ddb74ca6f31fdce665026c8701b4cae3aa093227576b68291
MD5 3da5b3e91decc5c2c9a45998daf14c94
BLAKE2b-256 be178d0c6daf6c460e488f33513621504d75530cdd2e5f246f70ea45413b5767

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_pack_cli-0.2.2.tar.gz:

Publisher: publish.yml on iamraydoan/ai-pack

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ai_pack_cli-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: ai_pack_cli-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for ai_pack_cli-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1346a43dad6cfef0775eeba0b057fd04a7a4a7f09ca5ac815d53f1d6b8bf1f53
MD5 28264a2e484aa4dc8ee4745d52208a9e
BLAKE2b-256 a05f12699350e77142f67354de5a119bfc9e80ccb780d17caec010aa7feda9c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_pack_cli-0.2.2-py3-none-any.whl:

Publisher: publish.yml on iamraydoan/ai-pack

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page