README.md

🧊 codebase consolidation.

ℹ️ Installation

$ pip install chonk

Note

It is generally recommended to add a .chonkignore file to the root directory of the codebase you wish to consolidate. Any files, folders, or file extensions specified in .chonkignore will be excluded from the output file. Refer to the .chonkignore.example for suggestions regarding what to include in .chonkignore.

To use this package outside of Python environments, install the package globally and ensure that the Python executable is added to your system's PATH. Execute the script simply by running

$ chonk

and follow the prompts by providing an input directory, an output file destination and optional filters.

Alternatively, the script can be executed using a single command with the appropriate flags:

$ chonk -i <input_path> -o <output_path> -f <optional filters>

For further information, run $ chonk --help.