Quick Start Overview

GH-Proxy is dedicated to solving network friction, slow clone rates, and timeout failures when developers access GitHub assets across different regions. The service requires zero client configuration and supports multiple direct usage patterns.

1. Quickest Usage: Prepending the Proxy Domain

Simply prepend https://gh-proxy.org/ before any valid GitHub resource URL to initiate an accelerated download:

# Original URL
https://github.com/torvalds/linux/archive/refs/tags/v6.8.tar.gz

# Accelerated URL with proxy prefix
https://gh-proxy.org/https://github.com/torvalds/linux/archive/refs/tags/v6.8.tar.gz

2. Accelerated Git Clone

When cloning a repository via git clone, prepend the proxy domain directly before the GitHub URL:

# Recommended command
git clone https://gh-proxy.org/https://github.com/username/repository.git

# Or configure global Git URL rewriting (see Git Client Configuration)

3. Raw Source Files & Automated Install Scripts

When running Linux install scripts (such as Docker, Rustup, or Node installers) via curl:

# Original install command
curl -fsSL https://raw.githubusercontent.com/homebrew/install/HEAD/install.sh | bash

# Accelerated execution
curl -fsSL https://gh-proxy.org/https://raw.githubusercontent.com/homebrew/install/HEAD/install.sh | bash

4. Supported Resource Types

• GitHub Releases: Binaries, installer packages, and asset archives (including dynamic latest/download resolution).
• Git Repositories & Archives: High-speed git clone acceleration, Zip/Tar.gz source archives across branches and tags.
• Raw Files & Scripts: raw.githubusercontent.com, legacy raw.github.com, in-repo raw links, and automatic rewrite of web blob URLs.
• GitHub Actions Artifacts: Workflow run build artifacts (direct download without logging in), check suites, and nightly.link bundles.
• Patches & Atom Feeds: Commit and pull request .patch and .diff files, alongside commit and release .atom syndicated feeds.
• Code Snippets & Short URLs: Gist code snippets and official gh.io shortened redirect links.
• REST APIs & Media Assets: Official GitHub REST API endpoints (with intelligent token pooling), user avatars, OpenGraph banners, and Desktop installer bundles.

For comprehensive matching rules and parameter specifications, please refer to the GitHub Accelerator Proxy User Guide.