🚀 GitIngest VS Code Extension

Seamlessly analyze your Git repositories inside VS Code!
GitIngest provides deep insights, a modern UI, and effortless integration into your workflow.

✨ Features at a Glance

🎯 Modern & Interactive UI

✅ Beautiful Webview interface with a sleek design.
✅ Interactive three-panel layout (Summary, Directory, File Content).
✅ One-click copy for all analysis sections.
✅ Real-time progress indicators.
✅ Fully responsive design, adapts to different screen sizes.

🛠 Smart & Comprehensive Analysis

✅ Scans your entire repository with automatic filtering.
✅ Excludes unnecessary files (build artifacts, binaries, IDE-specific files).
✅ Displays repository insights in an easy-to-read format.
✅ Searchable, copyable, and exportable results.

🔄 Seamless VS Code Integration

✅ Status Bar shortcut for quick access.
✅ Command Palette support ( Ctrl/Cmd + Shift + P ).
✅ Works across Windows, macOS, and Linux.

Analyzing a Specific Folder

✅ Right-click on any folder in the Explorer view.
✅ Select "GitIngest: Analyze This Folder" from the context menu.
✅ View the analysis results specific to that folder.

🏗️ Installation & Setup

🔹 Prerequisites

1. Python 3.x (Ensure it's added to system PATH)
2. VS Code 1.60.0 or higher
3. A Git Repository

🔹 Install the Extension

1. Install from the VS Code Marketplace.
2. Install required Python dependencies:

pip install gitingest
# or
pip3 install gitingest

🚀 How to Use

Open a local codebase

Start GitIngest

1. Via Explorer: Right click on any specific folder and choose Gitingest: Analyze this folder

2. Via Status Bar: Click the GitIngest icon for one-click access.

3. Via Command Palette (Ctrl/Cmd + Shift + P)
   • Run GitIngest: Analyze Repository to start analysis.
   • Run GitIngest: Show Setup Guide for setup help.

📊 Analysis Breakdown

Summary Panel

• High-level repository overview.
• Key insights and metrics.
• Easily copyable format.

Directory Structure

• Tree view of your project structure.
• Filters out unnecessary files.

File Content Analysis

• Highlights key file content.
• Searchable, structured, and copyable.

Save or export analysis data effortlessly:

⚙️ Configuration

GitIngest automatically manages:
✔ Python environment detection
✔ GitIngest package verification
✔ Platform-specific command execution
✔ Intelligent process management

🛡️ Security

✅ 100% Local Execution – No external API calls, everything runs on your machine.
✅ No Data Collection – Your data stays private.

❓ Troubleshooting

Common Issues & Fixes

🚧 Python Not Found?

✔ Ensure Python is installed and added to system PATH.
✔ Run GitIngest: Show Setup Guide in the command palette.

🚧 GitIngest Not Installed?

✔ Run pip install gitingest .
✔ Verify pip installation with pip --version .

🚧 Analysis Failing?

✔ Ensure repository access is configured correctly.
✔ Verify Python installation.
✔ Check user permissions.

📜 License

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

🙌 Acknowledgments

💙 GitIngest – Core engine.
💙 VS Code API – Enabling smooth integration.

Made with ❤️ for developers worldwide.