gitree 1.0.0

Gitree: git-aware project tree printing and zipping for docs and LLMs

Gitree

A git-aware (but not git-required) project tree printer and zipper for documentation, PRs and LLM workflows.

The problems it solves:

• sharing project structure in issues or pull requests
• generating directory trees for documentation
• pasting project layouts into LLMs
• zipping projects using .gitignore rules for safe sharing with LLMs

Quick Start (10 seconds)

Installation using pip (recommended):

Run this command in your terminal:

pip install gitree

Usage:

Open a terminal in any project and run:

gitree

This prints the directory structure of the current folder.

You can also specify a path explicitly:

gitree <directory_path>

Example on Windows PowerShell:

PS C:/Users/Projects/Gitree> gitree .

Note: The dot after the name call is not required. It is default.

Output:

Gitree
├─ LICENSE
├─ pyproject.toml
├─ README.md
├─ requirements.txt
└─ structure.py

For zipping a directory:

gitree . --zip out

creates out.zip in the same directory.

Updating Gitree:

To update the tool, reinstall it using pip. Pip will automatically replace the older version with the latest release.

Useful CLI arguments

In addition to the directory path, the following options are available:

Argument	Description
--version, -v	Displays the installed version.
--zip [name]	Zips the project while respecting .gitignore. Example: --zip a creates a.zip. If no name is provided, a random ID is used.
--depth	Limits recursion depth. Example: --depth 1 shows only top-level files and folders.
--all, -a	Includes hidden files and directories. Does not override .gitignore.
--ignore	Adds extra files or directories to ignore.
--gitignore-depth	Controls how deeply .gitignore files are discovered. Example: --gitignore-depth 0 uses only the root .gitignore.
--no-gitignore	Ignores all .gitignore rules when set.
--max-items	Limits items shown per directory. Extra items are summarized as ... and x more items. Default: 20.
--no-limit	Removes the per-directory item limit.

Installation (for Contributors)

Clone the repository:

git clone https://github.com/ShahzaibAhmad05/Gitree

Move into the project directory:

cd Gitree

Install dependencies:

pip install -r requirements.txt

The tool is now available as a Python CLI on your system.

For running directly from main without installing:

python -m gitree.main

Contributions

Issues and pull requests are welcome. Ideas that would fit well include improved formatting, colorized output, test coverage, and performance optimizations.

Gitree is intentionally small and readable, so contributions that preserve simplicity are especially appreciated.