JoeGlenn1213/lgh

中文文档
**LGH (LocalGitHub)** is a lightweight local Git hosting service. It wraps git http-backend to provide GitHub-like HTTP access, running entirely on localhost - turning your local directory into a Git server.
✨ Features
- 🚀 **Lightweight** - Single binary, no external dependencies
- 🔧 **Easy to Use** - Intuitive CLI commands, one-click repository setup
- 🌐 **HTTP Access** - Standard Git HTTP protocol, compatible with all Git clients
- 🔒 **Authentication** - Built-in Basic Auth with salted password hashing
- 🛡️ **Read-Only Mode** - Optional read-only mode to protect repositories
- 📡 **mDNS Discovery** - Automatic LAN discovery for team collaboration
- 🌍 **Tunnel Support** - One-click expose to internet (ngrok, cloudflared)
- ⚡ **Smart Archival (v1.2.0)** - lgh up / lgh save commands with auto .gitignore
- 🤖 **MCP Server (v1.2.0)** - AI Agent integration (Cursor, Claude Desktop)
📦 Installation
Option 1: Download Pre-built Binary (Recommended)
Download the pre-built binary for your system — these links always point to the latest release:
| OS | Architecture | Download |
|------|------|------|
| macOS | Apple Silicon (M1/M2/M3) | lgh-darwin-arm64 |
| macOS | Intel | lgh-darwin-amd64 |
| Linux | x86_64 | lgh-linux-amd64 |
| Linux | ARM64 | lgh-linux-arm64 |
| Windows | x86_64 | lgh-windows-amd64.exe |
Windows Installation
1. Download lgh-windows-amd64.exe
2. Rename to lgh.exe
3. Move to a folder in your %PATH% (e.g., C:\Program Files\lgh\)
4. Run in PowerShell or Command Prompt
Option 2: Install Script
Option 3: Homebrew (macOS)
Option 4: Build from Source
Option 5: Go Install
🚀 Quick Start
1. Initialize LGH Environment
This creates the necessary directories and config files in ~/.localgithub/.
2. Start the Server
Server listens on http://127.0.0.1:9418 by default.
3. One-Step Add & Push (v1.0.9+)
The fastest way to host a local project:
This single command will:
1. Initialize a Git repo (if not already one).
2. **Auto-Commit** all files (if the repo is empty).
3. Register it with LGH.
4. **Auto-Push** to the server immediately.
4. Add Without Pushing
If you prefer manual control:
5. Smart Archival (v1.2.0+)
The fastest way to backup and sync your code:
**Smart Ignore** automatically:
- Detects project type (Python, Go, Node, Java, Rust, AI/ML)
- Generates appropriate .gitignore file
- Blocks large files (>50MB) and sensitive files (.env, *.key)
- **(v1.2.3+)** When used via MCP, returns exact triggered_job_ids: [...] array, allowing AI to track pipeline status with zero blind spots
5. Push Code
After adding, you can use standard Git commands:
5. Clone from Elsewhere
📖 Command Reference
| Command | Description | Example |
|------|------|------|
| lgh init | Initialize LGH environment | lgh init |
| lgh serve | Start HTTP server | lgh serve -d |
| lgh stop | Stop running server | lgh stop |
| lgh add | Add repository to LGH | lgh add . --name my-repo |
| lgh list | List all repositories (detailed) | lgh list |
| lgh status | View server status and repo list | lgh status |
| lgh remove | Remove repository (use status/list first) | lgh remove my-repo |
| lgh tunnel | Expose to internet | lgh tunnel --method ngrok |
| lgh auth | Manage authentication | lgh auth setup |
| lgh -v | Show version | lgh -v |
| lgh doctor | Check system health | lgh doctor |
| lgh repo status | Check repo connection state | lgh repo status |