Skip to main content

LLM plugin to load entire folder contents as fragments

Project description

llm-fragments-folder

chat-bot cli-tool file-loader knowledge-base library llm python software-project llm-tools llm-plugins

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"

# Only load specific file types
llm -f "folder:./docs?glob=*.md,*.txt" "Summarize the docs"
llm -f "folder:.?glob=*.json,*.yaml" "Explain these configs"

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"

# Only Python files
llm -f "project:.?glob=*.py" "Review this code"

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

With ?glob= — you choose

When you specify ?glob=, the default extension allowlist is bypassed entirely. Every file matching your patterns is included — nothing is silently dropped. Use gitignore-style glob patterns, comma-separated. Negate with ! to exclude specific patterns.

# Only markdown files
llm -f "folder:./docs?glob=*.md" "Summarize these"

# Python files, excluding tests
llm -f "project:.?glob=*.py,!*_test.py,!tests/**" "Review the code"

# All dotfiles
llm -f "folder:~?glob=.*" "Explain my shell config"

# Multiple file types
llm -f "folder:.?glob=*.md,*.txt,*.json" "What's in here?"

# Files containing a keyword, excluding a type
llm -f "folder:.?glob=*finance*,!*.txt" "Summarize the finance docs"

Without ?glob= — sensible defaults

Without a filter, only files with recognized extensions and filenames are included. This curated allowlist keeps your context relevant — files like .log, .lock, and package-lock.json are excluded by default. If the defaults don't cover your needs, use ?glob= to take full control. Supported types include:

  • Documents: .md, .qmd, .txt, .rst, .adoc, .tex, .org
  • Code: .py, .js, .ts, .jsx, .tsx, .go, .rs, .java, .rb, .c, .cpp, .h, .cs, .swift, .kt, .scala, .r, .jl, .lua, .pl, .php, .sh, .bash, .zsh, .fish, .ps1, .bat
  • Config: .json, .yaml, .yml, .toml, .ini, .cfg, .conf, .env, .properties
  • Web: .html, .css, .scss, .sass, .less, .svg, .xml, .xsl
  • Data: .csv, .tsv, .sql, .graphql, .proto
  • Build: .dockerfile, .makefile, .cmake, .gradle, .sbt
  • Other: .tf, .hcl, .ipynb, .bib, .vim, .el
  • Dotfiles: .bashrc, .zshrc, .vimrc, .gitconfig, .tmux.conf, .profile, .editorconfig, .npmrc, .prettierrc, .eslintrc, etc.
  • Special files: Makefile, Dockerfile, LICENSE, Jenkinsfile, Procfile, Gemfile, etc.
  • Shebang scripts: extensionless files starting with #!

Always applies

  • Skipped directories: .git, .hg, .svn, node_modules, __pycache__, .tox, .nox, .mypy_cache, .pytest_cache, .ruff_cache, venv, .venv, env, .env, .eggs, dist, build, .idea, .vscode (plus any *.egg-info directory).
  • Binary files: Files containing null bytes are skipped automatically, even if matched by a glob pattern. No garbled PDFs or images in your context.
  • 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.4.1.tar.gz (10.4 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.4.1-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: llm_fragments_folder-0.4.1.tar.gz
  • Upload date:
  • Size: 10.4 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.4.1.tar.gz
Algorithm Hash digest
SHA256 a666b8a704f8b175825d9a21536129ebf8c494ce2e692cbecaad2a309dc99ff6
MD5 6d0b69b4bc4fda199fb0f67f4a3e8d76
BLAKE2b-256 8ea237831e5fb39d072cc259301702b76a89f66d1f7921b990c42f398611dd8b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for llm_fragments_folder-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 935907de22bfb117242756d8f8e945270ff11413cff4f79099296a9adb4b1e59
MD5 7ee83b5d66d51119f4999aae159bcbf0
BLAKE2b-256 90e7630e237c06809c66e57bc3be0f534bf040b8dfa18b06933c734cc3b11143

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