foldermix Docs

foldermix packs a local folder into one LLM-friendly context artifact you can inspect, share, or pipe into automation.

Where To Go Next

  • Quickstart: install foldermix, run the first pack, and preview what will be included.
  • Workflows: copy-pasteable recipes for AI context, legal review, research, support, course refresh, config-first, and jsonl report pipelines.
  • Configuration: config precedence, foldermix.toml discovery, command sections, starter profiles, and effective-config diagnostics.
  • Output Formats And Reports: when to choose Markdown, XML, or JSONL, and how to use --report.
  • Safety And Troubleshooting: sensitive-file handling, filters, policy dry-runs, OCR notes, and common fixes.
  • CLI Presentation Roadmap: the M3 documentation and CLI presentation plan.

Project Docs

  • README: full repository overview, command reference, report schema, release notes, and developer guide.
  • Contributing: contribution process and local development expectations.
  • Maintainer playbook: PR triage, release, coverage, and tap troubleshooting.

First Command

foldermix pack . --out context.md

This writes a Markdown bundle for the current folder. Run foldermix list . and foldermix skiplist . first when you want to inspect include and skip decisions before producing a bundle.

Install Paths

pip install foldermix

The default install is enough for text, Markdown, source code, config/data files, WebVTT, and notebooks.

Homebrew is available for the core CLI:

brew tap foldermix/foldermix
brew install foldermix

Homebrew does not install optional Python extras. Use a Python tool install when you need PDF, OCR, Office, or markitdown support:

uv tool install "foldermix[all,markitdown]"