Skip to content

API Reference

Complete reference documentation for Folder2MD4LLMs command-line interface and configuration options.

Command Line Interface

Command Line

Complete documentation of all command-line options, arguments, and flags.

Configuration File

Comprehensive reference for YAML configuration file options and syntax.

Quick Reference

For common commands and patterns, see the Quick Reference guide.

Configuration Schema

The configuration file uses YAML format with the following structure:

# Output settings
output: string                    # Output file path
format: string                   # Output format (markdown)

# Processing limits
token_limit: integer             # Maximum tokens in output
max_file_size: integer           # Maximum file size in bytes
parallel: boolean                # Enable parallel processing

# Content filtering
include_patterns: [string]       # Files to include
exclude_patterns: [string]       # Files to exclude
include_docs: boolean            # Include document conversion
binary_analysis: boolean         # Analyze binary files

# Smart condensing
smart_condensing: boolean        # Enable smart condensing
condense_strategy: string        # Strategy: conservative, balanced, aggressive
preserve_patterns: [string]      # Patterns to never condense

Environment Variables

  • FOLDER2MD_CONFIG: Path to configuration file
  • FOLDER2MD_UPDATE_CHECK: Disable update checks (set to false)
  • FOLDER2MD_LOG_LEVEL: Set logging level (DEBUG, INFO, WARNING, ERROR)

Exit Codes

  • 0: Success
  • 1: General error
  • 2: Configuration error
  • 3: File processing error
  • 4: Output error

Coming Soon

These API reference pages will include: - Complete CLI documentation - Configuration file schema - Python API reference (if applicable) - Plugin API documentation