Installation¶

Requires Python 3.11+

macOS (Homebrew) - Recommended for Mac Users¶

The easiest way to install folder2md4llms on macOS:

brew install henriqueslab/formulas/folder2md4llms

This installs: - folder2md CLI (folder2md command) - All dependencies (Python 3.13, libmagic)

Updating folder2md4llms:

brew update
brew upgrade folder2md4llms

Benefits: - Simple one-command installation - Automatic dependency management - Easy updates through Homebrew - Isolated Python environment

Note: Package name is folder2md4llms, but the command is folder2md.

All Platforms (pipx)¶

pipx install folder2md4llms

Alternative Methods¶

Using pip¶

pip install folder2md4llms

Development¶

git clone https://github.com/HenriquesLab/folder2md4llms.git
cd folder2md4llms
pip install -e ".[dev]"

Verification¶

folder2md --version
folder2md --help

Troubleshooting¶

Command not found?

# Add to PATH or use module directly
python -m folder2md4llms .

Need help? - GitHub Issues - GitHub Discussions

Next Steps¶

• First Conversion Guide
• Quick Reference
• User Guide