Quick Reference¶

Common folder2md commands. See the CLI reference for every option, or run folder2md --help.

Basic¶

# Convert the current directory to output.md
folder2md .

# Convert a specific directory
folder2md /path/to/project

# Choose the output file
folder2md . -o summary.md

# Copy the result to the clipboard
folder2md . --clipboard

Fitting a budget¶

--limit sets a size cap and turns on smart condensing automatically.

# Token budget
folder2md . --limit 80000t

# Character budget
folder2md . --limit 250000c

# Condense code using config defaults, without a hard limit
folder2md . --condense

Filtering¶

There are no include/exclude flags. Filtering is done with ignore files.

# Scaffold a .folder2md_ignore you can edit
folder2md --init-ignore

# Overwrite an existing one
folder2md --init-ignore --force

.gitignore is honoured by default (use_gitignore: true). Add patterns to .folder2md_ignore for anything Git tracks but you do not want in the output.

Configuration¶

For repeatable runs, put a folder2md.yaml in the directory you process:

output_format: markdown
include_tree: true
convert_docs: true
describe_binaries: true
condense_code: true
condense_languages: [python, js, ts]
token_limit: 80000

Then just run folder2md .. See the Configuration reference for all keys.

Utility¶

folder2md --version          # installed version
folder2md --help             # full option list
folder2md --changelog        # changelog for the current version
folder2md --upgrade-check    # check for a newer release
folder2md --upgrade --yes    # upgrade without a prompt