repoGhost 0.1.0.dev1

CLI tool to summarize code in a repo.

👻 repoGhost

repoGhost is a command-line tool to scan a local code repository, split files into chunks, and summarize each chunk using an LLM (e.g., GPT-4). Summaries are stored in summaries.json, and repeated runs skip unchanged files to save cost.

Features

• Hash-based caching: Skips unchanged files (no repeated LLM calls).
• Auto .gitignore: Automatically adds the cache and summary files to .gitignore if found.
• Clipboard: Copies the last summary to your clipboard for easy reference.
• Configurable chunk size: Choose how many lines per chunk.

Installation

pip install repoGhost

Usage

repoGhost --repo_path /path/to/your/repo --lines_per_chunk 30

Command-Line Arguments

• --repo_path: Path to the local repo (default ./my_repo).
• --lines_per_chunk: Lines per chunk for summarizing (default 30).

Example

repoGhost --repo_path ./my_project --lines_per_chunk 50

This generates two files in the specified repo path:

• hash_cache.json: Contains file hashes and chunk summaries (used to skip unchanged files).
• summaries.json: Contains all chunk summaries (the final output).

The last chunk’s summary is copied to your clipboard automatically.

Constants

In the code, the following constants can be modified to suit your needs:

EXCLUDED_DIRS = {
    "migrations",
    "static",
    "media",
    "__pycache__",
    ".git",
    "venv",
    "node_modules",
}
EXCLUDED_EXTENSIONS = {
    ".pyc", ".css", ".scss", ".png", ".jpg", ".jpeg", ".svg", ".sqlite3"
}
EXCLUDED_FILES = {"manage.py", "wsgi.py", "asgi.py", "package-lock.json"}
VALID_EXTENSIONS = {".py", ".js", ".html", ".json"}

Feel free to add or remove items based on the files you want to skip or process.

Customizing the Prompt & Model

Inside the script, the summarize_chunk function calls an OpenAI model:

openai.ChatCompletion.create(
    model="gpt-4o",  # or your custom model name
    messages=[
        {"role": "user", "content": f"Please summarize this code chunk concisely:\n\n{chunk}"}
    ],
    temperature=0.3,
    max_tokens=150
)

You can modify:

• The model parameter (e.g., gpt-3.5-turbo, gpt-4, gpt-4o-mini, etc.).
• The prompt text (if you want a different style of summary).
• The temperature or max_tokens values.

OpenAI API Key

You need an OPENAI_API_KEY set in your environment variables for the script to call OpenAI’s API. For instance:

export OPENAI_API_KEY="sk-1234..."

Then run:

repoGhost --repo_path /path/to/repo

Requirements

See requirements.txt. Python 3.7+ recommended.

• openai
• pyperclip
• rich

Development / Local Install

1. Clone this repo:

   git clone https://github.com/georgestander/repoGhost.git
   cd repoGhost
   

2. Install in editable mode:

   pip install -e .
   

3. Verify the CLI is installed:

   repoGhost --help
   

License

MIT License.