CLI Reference¶
Complete reference for the folder2md command. This mirrors folder2md --help; run that at any time for the authoritative list on your installed version.
Usage¶
PATH is the directory to process. It defaults to the current directory (.).
Options¶
| Option | Short | Description |
|---|---|---|
--output <file> | -o | Output file path. Defaults to output.md. |
--limit <size> | Size limit for the output; automatically enables smart condensing. Use t for tokens or c for characters, e.g. 80000t, 200000c. | |
--condense | Enable code condensing for supported languages, using the defaults from your config file. | |
--config <file> | -c | Path to a custom configuration file. |
--clipboard | Copy the final output to the system clipboard. | |
--init-ignore | Generate a .folder2md_ignore template in the target directory. | |
--force | Overwrite an existing .folder2md_ignore when used with --init-ignore. | |
--no-suggestions | Disable automatic file analysis and ignore-pattern suggestions. | |
--disable-update-check | Disable the automatic check for new versions. | |
--verbose | -v | Enable verbose logging. |
--changelog [<version>] | Show the changelog for the current or a specific version. | |
--changelog-recent <N> | Show the last N changelog versions (use with --changelog). | |
--upgrade | Upgrade folder2md4llms to the latest version. | |
--upgrade-check | Check for available updates without upgrading. | |
--yes | -y | Skip the confirmation prompt when upgrading. |
--version | Show the installed version and exit. | |
--help | -h | Show the help message and exit. |
There are no --include-pattern / --exclude-pattern flags. File selection is controlled by .folder2md_ignore and .gitignore (see Configuration).
Examples¶
Process the current directory:
Process a specific directory and write to a custom file:
Set a token limit (auto-enables smart condensing):
Set a character limit instead:
Enable default code condensing:
Copy the result to the clipboard:
Generate an ignore template, then edit it before your next run:
Configuration file¶
Anything beyond these flags is set in a folder2md.yaml file in the directory you process. See the Configuration reference for the full key list.