Skip to main content

LLM plugin to load entire folder contents as fragments

Project description

llm-fragments-folder

An LLM plugin that loads entire folder contents as fragments, turning any directory into a chat-ready knowledge base.

Installation

llm install llm-fragments-folder

Or install from source:

cd llm-fragments-folder
pip install -e .

Usage

Two fragment loaders are provided: folder: for general document collections and project: for software projects.

folder: - Load documents from a directory

# Chat against all docs in a folder
llm chat -f folder:./docs

# Ask a question about files in the current directory
llm -f folder:. "What are these documents about?"

# Combine with a specific model
llm -f folder:~/notes -m claude-sonnet-4-5 "Find all action items"

# Use with system fragments for custom instructions
llm -f folder:./research --sf "You are a research assistant" "Summarize the key findings"

project: - Load a software project (respects .gitignore)

# Explain a codebase
llm chat -f project:.

# Ask about a specific project
llm -f project:./my-app "What framework does this use?"

# Code review
llm -f project:. "Review this code for security issues"

# Architecture overview
llm -f project:~/repos/my-api -m claude-sonnet-4-5 "Describe the architecture"

The project: loader:

  • Uses git ls-files when inside a git repo (most accurate)
  • Falls back to parsing .gitignore patterns if git is not available
  • Prepends a file tree summary as the first fragment
  • Automatically skips node_modules, __pycache__, .git, venv, dist, build, etc.

Combining with other fragments

Fragments compose naturally with each other and with LLM's other features:

# Folder + URL context
llm -f folder:./docs -f https://example.com/api-spec "Compare our docs to the spec"

# Folder + system prompt
llm -f folder:./meeting-notes --system "Extract action items with owners and dates" ""

# Project + GitHub issue
llm install llm-fragments-github
llm -f project:. -f issue:user/repo/42 "Implement this feature"

What gets loaded

Text file detection is based on file extension and filename. Supported types include:

  • Documents: .md, .txt, .rst, .adoc, .tex, .org
  • Code: .py, .js, .ts, .go, .rs, .java, .rb, .c, .cpp, and many more
  • Config: .json, .yaml, .yml, .toml, .ini, .env, .cfg
  • Web: .html, .css, .scss, .svg, .xml
  • Data: .csv, .tsv, .sql, .graphql
  • Special files: Makefile, Dockerfile, LICENSE, etc.
  • Shebang scripts: extensionless files starting with #!

Always skipped directories: .git, node_modules, __pycache__, .venv, venv, dist, build, .idea, .vscode, .mypy_cache, .pytest_cache, etc.

Safety limits: Files larger than 1MB are skipped. Maximum 500 files per loader call.

How it works

Each file becomes a separate LLM fragment, wrapped with a filename header:

--- path/to/file.py ---
<file contents>

This means LLM's fragment deduplication works at the file level. If you reference the same folder across multiple prompts, files that haven't changed won't be stored again in the log database.

Development

# Clone and install for development
git clone https://github.com/michael-borck/llm-fragments-folder.git
cd llm-fragments-folder
uv sync

# Run tests
uv run pytest

# Lint and format
uv run ruff check .
uv run ruff format .

# Type checking
uv run mypy llm_fragments_folder.py

Acknowledgments

License

Apache 2.0

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

llm_fragments_folder-0.1.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

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

llm_fragments_folder-0.1.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file llm_fragments_folder-0.1.0.tar.gz.

File metadata

  • Download URL: llm_fragments_folder-0.1.0.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for llm_fragments_folder-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a511163b055c60b7afec6d565c2177d1035dacf81da28cf79b9536ce14f5ea52
MD5 949baf44c882cc2c52229b56c0ab2ad3
BLAKE2b-256 c7fd2d4e57d756a7ddef359537f83ace90c4403f1a08793253affd5e8461ebe0

See more details on using hashes here.

File details

Details for the file llm_fragments_folder-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for llm_fragments_folder-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 02e2f76ef215ada97c607c6dac2904a7add7e149671e6db16bb1580e59c0bc5e
MD5 7de3a8c27534cee2a0e0a136f893c845
BLAKE2b-256 e97fb692370f0c3ed0d72fe5d0ef3a84d9ac77f287d60bbe02596ae68689d458

See more details on using hashes here.

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