repo-context-packager 1.0.0

Pack Git Repository into a text file for use in LLM

Repo-Context-Packager

Pack Git Repository into a text file for use in LLM
Release 0.1

Instruction for Windows Users:

Step 1

Check if Python is installed in the system by the following command:

python --version

or

py --version

If Python is not installed, visit https://www.python.org/ -> Downlaods -> Windows,
and choose the latest Stable Releases to download and install.

Notes: make sure that the installation path of Python is in Windows PATH

Step 1.1

Download requirement.txt from the repository.

Install dependencies by the following commands:

py -m pip install -r requirement.txt

Step 2

Change directory to src/repo_context_packager with the following command:

cd src\repo_context_packager

Step 3

Run the script by the following command:

python pack-repo.py repo-path [-r [DAYS]] [-o] [output-file-name]

or

py pack-repo.py repo-path [-r [DAYS]] [-o] [output-file-name]

Details for arguments and options are listed below:
[-h] [--version] [--output [OUTPUT]] [--include INCLUDE] [--all] [--recent [RECENT]] [--line-number] [--dirs-only] paths [paths ...]

positional arguments	description
paths	Path to the repository / files in the same repository

options	description
-h, --help	show this help message and exit
--version, -v	show program's version number and exit
--output, -o [OUTPUT]	Output filename
--include, -i	INCLUDE Extensions to be included, separated by ",", e.g. ".js,.txt"
--all, -a	Show all files including hidden files (files that start with ".")
--recent, -r [RECENT]	Only include files modified within the last 7 days
--line-number, -l	Include line number when displaying file content output
--dirs-only, -d	Show only directory structure tree without file contents

Instruction for Mac/Linux Users:

Step 1

Check if Python is installed in the system by the following command:

python3 --version

If Python is not installed, visit https://www.python.org/ -> Downlaods -> macOS,
and choose the latest Stable Releases to download and install.

Alternatively, user can check if brew is available using command brew --version, and use brew to install Python with the following command:

brew install python

Step 1.1

Download requirement.txt from the repository.

Install dependencies by the following commands:

python3 -m pip install -r requirement.txt

Step 2

Change directory to src/repo_context_packager with the following command:

cd src/repo_context_packager

Step 3

Run the script by the following command:

python3 pack-repo.py repo-path [-r [DAYS]] [-o] [output-file-name]

Details for arguments and options are listed below:
[-h] [--version] [--output [OUTPUT]] [--include INCLUDE] [--all] [--recent [RECENT]] [--line-number] [--dirs-only] paths [paths ...]

positional arguments	description
paths	Path to the repository / files in the same repository

options	description
-h, --help	show this help message and exit
--version, -v	show program's version number and exit
--output, -o [OUTPUT]	Output filename
--include, -i	INCLUDE Extensions to be included, separated by ",", e.g. ".js,.txt"
--all, -a	Show all files including hidden files (files that start with ".")
--recent, -r [RECENT]	Only include files modified within the last 7 days
--line-number, -l	Include line number when displaying file content output
--dirs-only, -d	Show only directory structure tree without file contents

.TOML Configuration File

You can use a .pack-repo.toml file in the same directory of pack-repo.py to set default options for this script. To get started, go to the root directory of this repo, and copy the template file to src/ by the following command:

On Mac:

cp .pack-repo.template.toml src/.pack-repo.toml

On Windows:

copy .pack-repo.template.toml src\.pack-repo.toml

Then, open and edit .pack-repo.toml to set your preferred defaults. IMPORTANT: Command-line arguments will always override any settings from the .pack-repo.toml file.

License:

This project is licensed under BSD 2-Clause License.