| Name | folder2md4llms JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | None |
| Summary | A tool to convert folder structures and file contents into markdown for LLMs |
| upload_time | 2025-07-25 10:45:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# folder2md4llms
[](https://github.com/henriqueslab/folder2md4llms/actions/workflows/test.yml)
[](https://github.com/henriqueslab/folder2md4llms/actions/workflows/release.yml)
[](https://pypi.org/project/folder2md4llms/)
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/folder2md4llms/)
`folder2md4llms` is a powerful and flexible tool that converts a repository's contents into a single, LLM-friendly Markdown file. It's designed to be fast, configurable, and easy to use, with a focus on producing high-quality, structured output.
## ✨ Key Features
- **Smart Condensing**: Automatically condenses code to fit within a specified token or character limit without crude truncation.
- **Document Conversion**: Converts PDF, DOCX, XLSX, and other document formats into text.
- **Binary File Analysis**: Provides intelligent descriptions for images, archives, and other binary files.
- **Highly Configurable**: Use a `folder2md.yaml` file or command-line options to customize the output.
- **Fast and Efficient**: Leverages multi-threading and efficient file processing to handle large repositories quickly.
- **Advanced Filtering**: Uses `.gitignore`-style patterns to exclude files and directories.
## 🚀 Quick Start
### Installation
Choose between binary (standalone) or Python package installation:
#### 🚀 Binary Installation (Recommended)
**No Python required - fastest startup, single executable**
**macOS (Homebrew):**
```bash
# Add the tap first
brew tap henriqueslab/tap
# Binary version (cask) - recommended
brew install --cask folder2md4llms-binary
```
**Windows (Scoop):**
```bash
# Add the bucket
scoop bucket add folder2md4llms https://github.com/HenriquesLab/scoop-folder2md4llms
# Binary version - recommended
scoop install folder2md4llms-binary
```
**Manual Binary Installation:**
1. Download the appropriate binary from [GitHub Releases](https://github.com/henriqueslab/folder2md4llms/releases/latest):
- **macOS**: `folder2md-macos-x64` (Intel) or `folder2md-macos-arm64` (Apple Silicon)
- **Windows**: `folder2md-windows-x64.exe`
- **Linux**: Coming soon
2. Make executable (macOS/Linux): `chmod +x folder2md-*`
3. Move to PATH:
- **macOS/Linux**: `sudo mv folder2md-* /usr/local/bin/folder2md`
- **Windows**: Place `folder2md-windows-x64.exe` in a directory in your PATH
#### 🐍 Python Package Installation
**Requires Python 3.11+ - integrates with Python environment**
```bash
# Using uv (recommended)
uv add folder2md4llms
# Using pip
pip install folder2md4llms
```
#### Binary vs Python Package
| Feature | Binary | Python Package |
|---------|---------|----------------|
| **Python Required** | ❌ No | ✅ Yes (3.11+) |
| **Startup Time** | ⚡ Fast | 🐌 Slower |
| **File Size** | 📦 ~50MB | 📦 ~10MB |
| **Dependencies** | ✅ Self-contained | ⚠️ May conflict |
| **Updates** | 🔄 Manual/Package Manager | 🔄 pip/uv |
| **Use Case** | General users, CI/CD | Python developers |
### Basic Usage
```bash
# Process the current directory and save to output.md
folder2md .
# Process a specific directory and set a token limit
folder2md /path/to/repo --limit 80000t
# Copy the output to the clipboard
folder2md /path/to/repo --clipboard
# Generate a .folder2md_ignore file
folder2md --init-ignore
```
For a full list of commands and options, see the [CLI Reference](docs/api.md) or run `folder2md --help`.
> **Note**: The package name is `folder2md4llms` but the command is `folder2md` for convenience.
## 🔧 Configuration
You can configure `folder2md4llms` by creating a `folder2md.yaml` file in your repository's root directory. This allows you to set advanced options and define custom behavior.
For more details, see the [Configuration Guide](docs/api.md#configuration).
## 🛠️ Development
Interested in contributing? Get started with these simple steps:
```bash
# Clone the repository
git clone https://github.com/henriqueslab/folder2md4llms.git
cd folder2md4llms
# Set up the development environment
make setup
# See all available commands
make help
```
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For more information, see the [Contributing Guidelines](CONTRIBUTING.md).
## 📖 Documentation
- **[CLI Reference](docs/api.md)** - Complete command-line reference
- **[Contributing Guidelines](CONTRIBUTING.md)** - How to contribute to the project
- **[Changelog](CHANGELOG.md)** - Version history and changes
## 📦 Distribution Channels
- **PyPI**: [folder2md4llms](https://pypi.org/project/folder2md4llms/) - Python package
- **Homebrew**: [henriqueslab/tap](https://github.com/HenriquesLab/homebrew-folder2md4llms) - macOS binary
- **Scoop**: [HenriquesLab bucket](https://github.com/HenriquesLab/scoop-folder2md4llms) - Windows binary
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "folder2md4llms",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Ricardo Henriques <ricardo@henriqueslab.org>",
"download_url": "https://files.pythonhosted.org/packages/0d/a6/d6c65ddf432fafdd02f942a98abb8cde9ae862bc9d5d59f6d35f714dcfa0/folder2md4llms-0.5.0.tar.gz",
"platform": null,
"description": "# folder2md4llms\n\n[](https://github.com/henriqueslab/folder2md4llms/actions/workflows/test.yml)\n[](https://github.com/henriqueslab/folder2md4llms/actions/workflows/release.yml)\n[](https://pypi.org/project/folder2md4llms/)\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n[](https://pypi.org/project/folder2md4llms/)\n\n`folder2md4llms` is a powerful and flexible tool that converts a repository's contents into a single, LLM-friendly Markdown file. It's designed to be fast, configurable, and easy to use, with a focus on producing high-quality, structured output.\n\n## \u2728 Key Features\n\n- **Smart Condensing**: Automatically condenses code to fit within a specified token or character limit without crude truncation.\n- **Document Conversion**: Converts PDF, DOCX, XLSX, and other document formats into text.\n- **Binary File Analysis**: Provides intelligent descriptions for images, archives, and other binary files.\n- **Highly Configurable**: Use a `folder2md.yaml` file or command-line options to customize the output.\n- **Fast and Efficient**: Leverages multi-threading and efficient file processing to handle large repositories quickly.\n- **Advanced Filtering**: Uses `.gitignore`-style patterns to exclude files and directories.\n\n## \ud83d\ude80 Quick Start\n\n### Installation\n\nChoose between binary (standalone) or Python package installation:\n\n#### \ud83d\ude80 Binary Installation (Recommended)\n**No Python required - fastest startup, single executable**\n\n**macOS (Homebrew):**\n```bash\n# Add the tap first\nbrew tap henriqueslab/tap\n\n# Binary version (cask) - recommended\nbrew install --cask folder2md4llms-binary\n```\n\n**Windows (Scoop):**\n```bash\n# Add the bucket\nscoop bucket add folder2md4llms https://github.com/HenriquesLab/scoop-folder2md4llms\n\n# Binary version - recommended\nscoop install folder2md4llms-binary\n```\n\n**Manual Binary Installation:**\n1. Download the appropriate binary from [GitHub Releases](https://github.com/henriqueslab/folder2md4llms/releases/latest):\n - **macOS**: `folder2md-macos-x64` (Intel) or `folder2md-macos-arm64` (Apple Silicon)\n - **Windows**: `folder2md-windows-x64.exe`\n - **Linux**: Coming soon\n2. Make executable (macOS/Linux): `chmod +x folder2md-*`\n3. Move to PATH:\n - **macOS/Linux**: `sudo mv folder2md-* /usr/local/bin/folder2md`\n - **Windows**: Place `folder2md-windows-x64.exe` in a directory in your PATH\n\n#### \ud83d\udc0d Python Package Installation\n**Requires Python 3.11+ - integrates with Python environment**\n\n```bash\n# Using uv (recommended)\nuv add folder2md4llms\n\n# Using pip\npip install folder2md4llms\n```\n\n#### Binary vs Python Package\n\n| Feature | Binary | Python Package |\n|---------|---------|----------------|\n| **Python Required** | \u274c No | \u2705 Yes (3.11+) |\n| **Startup Time** | \u26a1 Fast | \ud83d\udc0c Slower |\n| **File Size** | \ud83d\udce6 ~50MB | \ud83d\udce6 ~10MB |\n| **Dependencies** | \u2705 Self-contained | \u26a0\ufe0f May conflict |\n| **Updates** | \ud83d\udd04 Manual/Package Manager | \ud83d\udd04 pip/uv |\n| **Use Case** | General users, CI/CD | Python developers |\n\n### Basic Usage\n\n```bash\n# Process the current directory and save to output.md\nfolder2md .\n\n# Process a specific directory and set a token limit\nfolder2md /path/to/repo --limit 80000t\n\n# Copy the output to the clipboard\nfolder2md /path/to/repo --clipboard\n\n# Generate a .folder2md_ignore file\nfolder2md --init-ignore\n```\n\nFor a full list of commands and options, see the [CLI Reference](docs/api.md) or run `folder2md --help`.\n\n> **Note**: The package name is `folder2md4llms` but the command is `folder2md` for convenience.\n\n## \ud83d\udd27 Configuration\n\nYou can configure `folder2md4llms` by creating a `folder2md.yaml` file in your repository's root directory. This allows you to set advanced options and define custom behavior.\n\nFor more details, see the [Configuration Guide](docs/api.md#configuration).\n\n## \ud83d\udee0\ufe0f Development\n\nInterested in contributing? Get started with these simple steps:\n\n```bash\n# Clone the repository\ngit clone https://github.com/henriqueslab/folder2md4llms.git\ncd folder2md4llms\n\n# Set up the development environment\nmake setup\n\n# See all available commands\nmake help\n```\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request. For more information, see the [Contributing Guidelines](CONTRIBUTING.md).\n\n## \ud83d\udcd6 Documentation\n\n- **[CLI Reference](docs/api.md)** - Complete command-line reference\n- **[Contributing Guidelines](CONTRIBUTING.md)** - How to contribute to the project\n- **[Changelog](CHANGELOG.md)** - Version history and changes\n\n## \ud83d\udce6 Distribution Channels\n\n- **PyPI**: [folder2md4llms](https://pypi.org/project/folder2md4llms/) - Python package\n- **Homebrew**: [henriqueslab/tap](https://github.com/HenriquesLab/homebrew-folder2md4llms) - macOS binary\n- **Scoop**: [HenriquesLab bucket](https://github.com/HenriquesLab/scoop-folder2md4llms) - Windows binary\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tool to convert folder structures and file contents into markdown for LLMs",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/henriqueslab/folder2md4llms",
"Issues": "https://github.com/henriqueslab/folder2md4llms/issues",
"Repository": "https://github.com/henriqueslab/folder2md4llms"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "da79a324b97288438976fb8472f359e8b8ea730f0e36a5de7e7cc1f64ea8e1c0",
"md5": "d13e75c76a0577bed4faeb0b7ff46ea1",
"sha256": "f9e563c8886e9a65fb8d8ca32d77f7a08242d798aec4f70f5b1aba9598501274"
},
"downloads": -1,
"filename": "folder2md4llms-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d13e75c76a0577bed4faeb0b7ff46ea1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 110333,
"upload_time": "2025-07-25T10:45:19",
"upload_time_iso_8601": "2025-07-25T10:45:19.502687Z",
"url": "https://files.pythonhosted.org/packages/da/79/a324b97288438976fb8472f359e8b8ea730f0e36a5de7e7cc1f64ea8e1c0/folder2md4llms-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0da6d6c65ddf432fafdd02f942a98abb8cde9ae862bc9d5d59f6d35f714dcfa0",
"md5": "7bf73b2b96af9841ef980c78bd8eab46",
"sha256": "22160078d8e568ebb783a51cd9a9b9733d2232fff3d1a8ce4bcb7d2df580fbf2"
},
"downloads": -1,
"filename": "folder2md4llms-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "7bf73b2b96af9841ef980c78bd8eab46",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 246190,
"upload_time": "2025-07-25T10:45:20",
"upload_time_iso_8601": "2025-07-25T10:45:20.718003Z",
"url": "https://files.pythonhosted.org/packages/0d/a6/d6c65ddf432fafdd02f942a98abb8cde9ae862bc9d5d59f6d35f714dcfa0/folder2md4llms-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 10:45:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "henriqueslab",
"github_project": "folder2md4llms",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "folder2md4llms"
}
