Gitload-txt NPM

gitload-txt

Generate enriched, AI-ready summaries of GitHub repositories as text files. Perfect for use with AI-powered IDEs like Cursor and other development tools.

Features

📦 Download any public GitHub repository as an enriched text summary
🔍 Smart filtering of relevant code and documentation
📝 Includes key architectural decisions and patterns
🏷️ Auto-generated tags for better organization
🚀 Compatible with popular AI coding assistants
💻 Simple CLI interface

Installation

npm install -g gitload-txt

Usage

Basic usage:

gitload https://github.com/username/repository

This will create a repository-name.txt file in a repos folder in your current directory with an enriched summary of the repository.

Output Format

The generated text file includes:

Repository Overview
- Basic information
- Main technologies used
- Architecture overview
- Dependencies
Code Structure
- Directory layout
- Key files and their purposes
- Important patterns and conventions
Documentation Summary
- README highlights
- API documentation
- Contributing guidelines
- License information
Auto-generated Tags (when --tags is used)
- Technology stack
- Programming paradigms
- Architecture patterns
- Domain categories

Example Output

Repository: awesome-project
URL: https://github.com/username/awesome-project
Generated: 2024-12-04

OVERVIEW
========
A Node.js backend service using Express.js and MongoDB...

ARCHITECTURE
============
- Microservices architecture
- REST API endpoints
- JWT authentication
- Redis caching layer

KEY COMPONENTS
=============
/src
  /routes - API endpoint definitions
  /controllers - Business logic
  /models - MongoDB schemas
  /middleware - Auth and validation
  /utils - Helper functions

[... continues with more detailed information ...]

TAGS
====
#nodejs #express #mongodb #microservices #jwt #redis

Using with AI IDEs

Cursor

Import the generated text file into your Cursor workspace
Use @repository-name.txt to query the summary
Generate code based on the repository

Other AI IDEs

The generated summaries are compatible with most AI-powered development tools that accept context in text format.

Configuration

Create a .gitloadrc file in your home directory to set default options:

{
  "outputDir": "./summaries",
  "defaultDepth": "detailed",
  "includeTags": true,
  "excludePatterns": ["*.test.js", "*.spec.js"],
  "maxFileSize": "10mb"
}

API Usage

You can also use gitload-txt programmatically in your Node.js applications:

const { generateSummary } = require('gitload-txt');

async function getSummary() {
  try {
    const summary = await generateSummary('https://github.com/username/repository', {
      depth: 'detailed',
      includeTags: true
    });
    console.log(summary);
  } catch (error) {
    console.error('Error generating summary:', error);
  }
}

Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

Development Setup

# Clone the repository
git clone https://github.com/username/gitload-txt

# Install dependencies
npm install

# Run tests
npm test

# Build the project
npm run build