GitGrok

Transform any Git repository into AI-friendly text

Demo • Report Bug • Request Feature

🚀 About GitGrok

GitGrok is a powerful web application that converts entire Git repositories into prompt-friendly text digests optimized for Large Language Models (LLMs). Whether you're feeding codebases to AI assistants, creating documentation, or analyzing code structure, GitGrok makes it effortless.

✨ Key Features

• 🔥 Lightning Fast: Process repositories in seconds with optimized parsing
• 🔒 Privacy First: Zero data retention, no accounts required, your code stays private
• 🔐 Private Repository Support: Access private repositories with GitHub Personal Access Token
• 🤖 AI-Optimized: Smart filtering and formatting designed for LLM consumption
• 📄 Multi-Format Output: Export as Markdown, JSON, or plain text
• 🌐 Universal Support: Works with GitHub, GitLab, Bitbucket, and any public Git repository
• ⚙️ Advanced Options: Configurable file filtering, size limits, and smart exclusions
• 🎨 Beautiful Interface: Modern, responsive design with dark/light mode support

🛠️ Installation

Prerequisites

• Node.js 18.0 or later
• npm, yarn, pnpm, or bun

Local Development

1. Clone the repository

   git clone https://github.com/yourusername/gitgrok.git
   cd gitgrok

2. Install dependencies

   npm install
   # or
   yarn install
   # or
   pnpm install
   # or
   bun install

3. Run the development server

   npm run dev
   # or
   yarn dev
   # or
   pnpm dev
   # or
   bun dev

4. Open your browser

   Navigate to http://localhost:3000 to see the application.

Environment Variables

Create a .env.local file in the root directory:

# Add any required environment variables here
# Currently, GitGrok works without additional configuration

🎯 Usage

1. Enter Repository URL: Paste any public Git repository URL (GitHub, GitLab, Bitbucket)
2. Private Repository: Check the "Private Repository" option if accessing a private repository
3. GitHub Token: If private repository is selected, provide your GitHub Personal Access Token
4. Configure Options: Use quick toggles or advanced options to customize processing
5. Generate Digest: Click "Generate Digest" and wait for processing
6. View Results: Results appear in a scrollable modal with tabs for Preview, Statistics, and Raw Output
7. Export: Copy to clipboard or download as a file

Private Repository Access

To access private repositories:

1. Check the "Private Repository" option
2. Provide a GitHub Personal Access Token (PAT) with appropriate permissions
3. The token should have at least repo scope for private repositories
4. Learn how to create a PAT

Supported Repository Formats

• https://github.com/owner/repository
• https://gitlab.com/owner/repository
• https://bitbucket.org/owner/repository

Output Formats

• Markdown: Best for LLMs and documentation (default)
• JSON: Structured data with metadata
• Plain Text: Simple concatenated files

🏗️ Project Structure

gitgrok/
├── app/                    # Next.js app directory
│   ├── api/               # API routes
│   │   └── process-repo/  # Repository processing endpoint
│   ├── components/        # React components
│   │   ├── advanced-options.tsx
│   │   ├── feature-grid.tsx
│   │   ├── icons.tsx
│   │   ├── repository-input.tsx
│   │   └── result-display.tsx
│   ├── globals.css        # Global styles
│   ├── layout.tsx         # Root layout
│   └── page.tsx          # Home page
├── components/            # Shared UI components
│   └── ui/               # shadcn/ui components
├── lib/                  # Utility functions
├── public/               # Static assets
└── README.md

🛠️ Built With

• Next.js 14 - React framework with App Router
• TypeScript - Type-safe JavaScript
• Tailwind CSS - Utility-first CSS framework
• shadcn/ui - Beautiful UI components
• Lucide React - Icon library
• next-themes - Theme management

🤝 Contributing

We love contributions! GitGrok is an open source project and we welcome contributions of all kinds.

How to Contribute

1. Fork the repository
2. Create a feature branch

   git checkout -b feature/amazing-feature

3. Make your changes
4. Commit your changes

   git commit -m 'Add some amazing feature'

5. Push to the branch

   git push origin feature/amazing-feature

6. Open a Pull Request

Development Guidelines

• Code Style: We use ESLint and Prettier for code formatting
• Commits: Use conventional commit messages
• Testing: Add tests for new features
• Documentation: Update documentation for significant changes

Areas for Contribution

• 🐛 Bug fixes
• ✨ New features
• 📚 Documentation improvements
• 🎨 UI/UX enhancements
• 🔧 Performance optimizations
• 🌐 Internationalization
• 🧪 Testing improvements

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Next.js team for the amazing framework
• Vercel for hosting and deployment
• shadcn for the beautiful UI components
• All contributors who help make GitGrok better

📞 Support

• 📧 Email: support@bugshoot.com
• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions

🗺️ Roadmap

• Private repository support with authentication
• CLI tool for command-line usage
• Browser extension
• API for programmatic access
• Batch processing for multiple repositories
• Custom filtering rules
• Integration with popular AI platforms

---

Made with ❤️ by the Bugshoot team

⭐ Star us on GitHub if you find GitGrok useful!