Troubleshooting¶
Quick solutions for common issues. For more help, see Support.
Installation Issues¶
Command Not Found¶
Permission Errors¶
Python Version¶
Requires Python 3.11+. Check with:
Configuration Issues¶
Invalid Configuration¶
Pattern Matching¶
# Test patterns
folder2md --dry-run --include-pattern "src/**/*.py"
# Use ** for subdirectories
folder2md --include-pattern "**/*.py" # ✓
folder2md --include-pattern "*.py" # Only root level
Processing Issues¶
File Errors¶
# Use verbose mode to identify issues
folder2md --verbose .
# Exclude problematic files/directories
folder2md --exclude-pattern "**/problem-dir/**" .
Memory Issues¶
# Reduce file size limit
folder2md --max-file-size 100000 .
# Use aggressive condensing
folder2md --smart-condensing --condense-strategy aggressive .
Token Limit Issues¶
Output Too Large¶
# Set token limit with smart condensing
folder2md --smart-condensing --token-limit 80000 .
# Use aggressive strategy
folder2md --smart-condensing --condense-strategy aggressive .
Document Conversion Issues¶
# Exclude problematic documents
folder2md --exclude-pattern "**/*.pdf" .
# Check dependencies
pip install python-docx openpyxl pypdf
Update Check Issues¶
Debugging¶
# Enable verbose mode
folder2md --verbose .
# Test with dry run
folder2md --dry-run .
# Start minimal and add features incrementally
folder2md --output test.md src/
Getting Help¶
- Check Support page
- Search GitHub Issues
- Create new issue with:
folder2md --versionoutputpython --versionoutput- Complete error message
- Minimal reproduction steps