Skip to content

greptileai/repo-summarizer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Repository Summarizer

A CLI tool that summarizes files in a directory using OpenAI's API.

Installation

npm install
npm run build

Usage

# Using environment variable for API key
export OPENAI_API_KEY="your-api-key-here"
npm run dev -- --directory ./test-directory

# Or using CLI option
npm run dev -- --directory ./test-directory --api-key your-api-key-here

# Save output to file
npm run dev -- --directory ./test-directory --output results.json

# Use different model
npm run dev -- --directory ./test-directory --model gpt-4

# Enable debug logging
npm run dev -- --directory ./test-directory --log-level debug

Options

  • -d, --directory <path>: Directory to process (required)
  • -o, --output <file>: Output JSON file path (optional)
  • -k, --api-key <key>: OpenAI API key (optional if OPENAI_API_KEY env var is set)
  • -l, --log-level <level>: Log level (debug, info, warn, error) - default: info
  • -m, --model <model>: OpenAI model to use - default: gpt-3.5-turbo

Features

  • Automatic text file detection
  • Skips binary files
  • Comprehensive logging
  • JSON output with metadata

Output Format

{
  "totalFiles": 5,
  "processedFiles": 4,
  "skippedFiles": 1,
  "summaries": [
    {
      "filePath": "/path/to/file.js",
      "fileName": "file.js",
      "summary": "This file contains...",
      "fileSize": 1024,
      "processedAt": "2023-01-01T12:00:00.000Z"
    }
  ],
  "processingTime": 5000
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published