Skip to content

Getting Started

Welcome to Folder2MD4LLMs! This guide will help you get up and running quickly with converting your projects into LLM-friendly Markdown.

Overview

Folder2MD4LLMs is designed to make it easy to share your codebase with AI assistants like Claude, GPT-4, or other LLMs. It intelligently processes your project files and creates a single, well-structured Markdown document that maintains important context while fitting within token limits.

What You'll Learn

In this section, you'll learn how to:

  1. Install Folder2MD4LLMs - Set up the tool on your system
  2. Perform Your First Conversion - Convert your first project
  3. Use the Quick Reference - Find common commands and patterns

Key Concepts

Before diving in, here are the core concepts you should understand:

Smart Condensing

Unlike simple truncation, Folder2MD4LLMs uses AST analysis to intelligently condense code while preserving meaning and structure.

Token Management

The tool provides precise control over output size, ensuring your converted project fits within your LLM's context window.

Document Conversion

Beyond code files, the tool can convert PDFs, DOCX files, and other documents into text format.

Binary Analysis

For non-text files like images and archives, the tool provides intelligent descriptions rather than raw binary data.

Installation Options

Choose the installation method that works best for you:

pipx install folder2md4llms

Binary Download

Download standalone executables from GitHub Releases.

Package Managers

  • Homebrew (macOS): brew install folder2md4llms
  • Scoop (Windows): scoop install folder2md4llms

Quick Example

Here's a simple example to get you started:

# Convert current directory
folder2md .

# Convert with smart condensing
folder2md . --token-limit 80000

# Convert specific directory with custom output
folder2md /path/to/project --output project-summary.md

Next Steps

  1. Install the tool using your preferred method
  2. Try a simple conversion on a small project
  3. Explore configuration options for more complex scenarios
  4. Read the user guides for advanced features

Ready to get started? Head to the Installation Guide to set up Folder2MD4LLMs on your system.