Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 70 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
[![Ask Zread](https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=00b0aa&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff)](https://zread.ai/xixu-me/Xget)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/xixu-me/Xget)
[![codecov](https://codecov.io/github/xixu-me/xget/graph/badge.svg?token=KDFMG9YX8G)](https://codecov.io/github/xixu-me/xget)
[![Chromium](https://img.shields.io/badge/Chromium-4285F4?logo=googlechrome&logoColor=white)](#-ecosystem-integration)
[![Firefox](https://img.shields.io/badge/Firefox-FF7139?logo=Firefox&logoColor=white)](#-ecosystem-integration)
[![Chromium](https://img.shields.io/badge/Chromium-4285F4?logo=googlechrome&logoColor=white)](#ecosystem-integration)
[![Firefox](https://img.shields.io/badge/Firefox-FF7139?logo=Firefox&logoColor=white)](#ecosystem-integration)

[![Cloudflare](https://img.shields.io/badge/Cloudflare-F38020?&logo=cloudflare&logoColor=white)](#deploy-to-cloudflare-workers)
[![EdgeOne](https://img.shields.io/badge/EdgeOne-006EFF?&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAACNklEQVR4nJ1W7XHbMAx96ul/lQnCDapOUG3gdIIkG6QjdINOUGeDNhNYmUDuBHIWiNQF/PqDYAxDoMUGdzx+AXgAAQGqSKKAOgAbma8BXMn5DGAv4wlAv6qJ5KVxR3LkOR3NWu9HkcnqzF0EkoMDcsysLd8oOooAb0lOF7wqpYnkzRrgZkVJ8mp0jLFzotscYOC6ZyNjjLbOnTZI7weSjQc4ZoQmkjuSneIdMoADyR9iVKuB0qglWYOT0n9Uys/qPAD4ZHgfAXwzfO/6LLyxcTxbJEdufFi1aEk32l6Z+1Lhep1lQa1aVwI2O3wBsTIFxOoUADzVspgzQp6S1pztATRyvpG5lTNLTUVykssJwF91OQP4bATuAGzVngBexJD0vJW51/u5VpZc4VSUgViMLX1xlIUCoERNLoYE8Ns579S6chTngGYZh1oWjRGoEGOjKSAGP/HovqblDoiJtAfwLPv5xHnqCrbNeK3K8qX9juQDMx3CVpoesXLop7DeATF+2rsKsbo8oizD3zzsjLWk30RHw7N7R5V68/AgMUpeWg9bLLOxL/AniOw1Yp58t/FZi5+mzuFrJJY/Sb6qFzmmV9PMgzBsHUW/eN5gJwdk54Rm4YTXgHPx00p24qEGydFElb3e09nUbpXVuZ+oS/88Z62rJLMelHAJSDqf6LxWSXvS35/+Vr0SlqrPHsBXxOw/o5IGHDLKE4AucS8A7hG7zAIMACryv371WxkfxYhZFD8jFvt+TdE/deK28xBAUlEAAAAASUVORK5CYII=)](#deploy-to-edgeone-pages)
Expand All @@ -26,6 +26,33 @@
> [!TIP]
> 欢迎加入“Xget 开源与 AI 交流群”,一起交流开源项目、AI 应用、工程实践、效率工具和独立开发;如果你也在做产品、写代码、折腾项目或者对开源和 AI 感兴趣,欢迎[**进群**](https://file.xi-xu.me/QR%20Codes/%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81.png)认识更多认真做事、乐于分享的朋友。

An ultra-high-performance, secure, all-in-one acceleration engine for developer
resources. It provides unified, efficient acceleration for code hosting, model
and dataset hubs, package registries, container registries, AI inference
providers, and more, while handling caching, retries, security headers, and
protocol-specific compatibility behavior for you.

Technical deep dive:
**_[Deep Dive into Xget: A High-Performance, Multi-Protocol, and Secure Acceleration Engine for Developer Resources](https://blog.xi-xu.me/en/2025/10/07/Deep-Dive-into-Xget.html)_**.

Xget was invited onto [GitCode](https://gitcode.com/xixu-me/xget) and
recognized as a G-Star graduation project. As "a widely used public project",
it receives support from OpenAI's
[Codex for Open Source](https://developers.openai.com/community/codex-for-oss)
and has also been spontaneously recommended by several tech creators, including
[Ruan Yifeng](https://www.ruanyifeng.com/blog/2025/12/weekly-issue-379.html#:~:text=Xget),
[GitHubDaily](https://x.com/i/status/1956204203937829256),
[FishC](https://www.bilibili.com/video/BV1EeeBzVEop/), and
[Xuanli 199](https://www.bilibili.com/video/BV197hqzsE8Y/?t=8). Thanks to every
individual, team, and community that supports, shares, recommends, or actively
uses Xget.

## Supported Platforms

> [!NOTE]
> The badges below point to the relevant usage or deployment sections in this
> README.

[![GitHub](https://img.shields.io/badge/GitHub-181717?&logo=github&logoColor=white)](#github)
[![GitLab](https://img.shields.io/badge/GitLab-FC6D26?&logo=gitlab&logoColor=white)](#gitlab)
[![Gitea](https://img.shields.io/badge/Gitea-609926?&logo=gitea&logoColor=white)](#gitea)
Expand Down Expand Up @@ -62,31 +89,7 @@
[![Container Registries](https://img.shields.io/badge/Container%20Registries-262261?logo=opencontainersinitiative&logoColor=white)](#container-registries)
[![AI Inference Providers](https://img.shields.io/badge/AI%20Inference%20Providers-94A3B8?logo=openrouter&logoColor=white)](#ai-inference-providers)

An ultra-high-performance, secure, all-in-one acceleration engine for
developer resources. It significantly outperforms traditional solutions and
provides unified, efficient acceleration for code hosting, model and dataset
hubs, package registries, container registries, AI inference providers, and
more, while handling caching, retries, security headers, and protocol-specific
compatibility behavior for you.

Technical deep dive:
**_[Deep Dive into Xget: A High-Performance, Multi-Protocol, and Secure Acceleration Engine for Developer Resources](https://blog.xi-xu.me/en/2025/10/07/Deep-Dive-into-Xget.html)_**.

Xget was invited to join the
[GitCode platform](https://gitcode.com/xixu-me/xget) and recognized as a G-Star
graduation project. As "a widely used public project", it is also supported by
OpenAI's
[Codex for Open Source](https://developers.openai.com/community/codex-for-oss).
It has also received spontaneous recommendations from several tech creators,
including
[Ruan Yifeng](https://www.ruanyifeng.com/blog/2025/12/weekly-issue-379.html#:~:text=Xget),
[GitHubDaily](https://x.com/i/status/1956204203937829256),
[FishC](https://www.bilibili.com/video/BV1EeeBzVEop/), and
[Xuanli 199](https://www.bilibili.com/video/BV197hqzsE8Y/?t=8). Thanks to every
individual, team, and community that supports, shares, recommends, or actively
uses Xget.

## 🎯 Quick Start
## Quick Start

**Pre-deployed Instance: `xget.xi-xu.me`** - For evaluation and trial only,
deploy your own instance for production or availability-sensitive workloads
Expand All @@ -100,23 +103,23 @@ supported platform URL to Xget's acceleration format with one click

**Agent Skills: `npx skills add xixu-me/skills -s xget`**

## 🌟 Core Advantages - Why Choose Xget?
## Why Xget

### Performance-Oriented Design
### Performance-Oriented Design

- **🌐 Global Edge Runtime**: Built on Cloudflare Workers and designed to run
- **Global Edge Runtime**: Built on Cloudflare Workers and designed to run
close to users and upstream services
- **Protocol-Aware Handling**: Supports HTTP/3, range requests, Git traffic,
- **Protocol-Aware Handling**: Supports HTTP/3, range requests, Git traffic,
container registry flows, and AI inference APIs
- **📦 Cache and Retry Pipeline**: Includes edge caching for compatible
- **Cache and Retry Pipeline**: Includes edge caching for compatible
responses, retry logic for transient upstream failures, and request
normalization for supported platforms
- **🔗 Connection Reuse**: Uses standard HTTP connection reuse and keep-alive
- **Connection Reuse**: Uses standard HTTP connection reuse and keep-alive
behavior where the runtime and upstream allow it
- **📊 Request Timing Visibility**: Can expose timing data through
- **Request Timing Visibility**: Can expose timing data through
`X-Performance-Metrics` headers where protocol compatibility allows

### 🌐 Deep Multi-Platform Integration
### Deep Multi-Platform Integration

- **All-in-One Multi-Platform Support**: Unified support for mainstream
platforms in various development scenarios
Expand All @@ -125,7 +128,7 @@ supported platform URL to Xget's acceleration format with one click
- **Consistent Acceleration Experience**: Enjoy unified and stable ultra-fast
download experience regardless of file type or source

### 🔒 Enterprise-Grade Security
### Enterprise-Grade Security

- **Multi-Layer Security Headers**:
- `Strict-Transport-Security`: Enforces HTTPS transmission, prevents
Expand All @@ -146,7 +149,7 @@ supported platform URL to Xget's acceleration format with one click
- **Timeout Protection**: 30-second request timeout, prevents resource
exhaustion and malicious requests

### 🚀 Modern Architecture and Reliability
### Modern Architecture and Reliability

- **Intelligent Retry Mechanism**:
- Maximum 3 retries with linear delay strategy (1000ms × retry count)
Expand All @@ -164,7 +167,7 @@ supported platform URL to Xget's acceleration format with one click
header
- Cache hit rate statistics and optimization recommendations

### 🎯 Full Git Protocol Compatibility
### Full Git Protocol Compatibility

- **Smart Protocol Detection**:
- Automatically recognizes Git-specific endpoints (`/info/refs`,
Expand All @@ -182,7 +185,7 @@ supported platform URL to Xget's acceleration format with one click
- Smart User-Agent handling (default `git/2.34.1`)
- Supports Git LFS large file transfer

### 📱 Ecosystem Integration
### Ecosystem Integration

- **Dedicated Browser Extension**:
[Xget Now](https://github.com/xixu-me/Xget-Now) provides seamless experience
Expand All @@ -195,7 +198,7 @@ supported platform URL to Xget's acceleration format with one click
- **CI/CD Integration**: Can be used directly in GitHub Actions, GitLab CI, and
other environments

## 🏗️ System Architecture
## Architecture

### Request Processing Flow

Expand Down Expand Up @@ -290,7 +293,7 @@ classDiagram
PlatformRouting --> PlatformCatalog
```

## 📖 URL Conversion Rules
## URL Conversion Rules

Using the pre-deployed instance **`xget.xi-xu.me`** or your own deployed
instance, simply replace the domain and add the platform prefix:
Expand Down Expand Up @@ -933,7 +936,7 @@ https://xget.xi-xu.me/ip/huggingface/hf-inference/models/openai/whisper-large-v3
For use cases, see
[AI Inference API Acceleration](#ai-inference-api-acceleration).

## 🎯 Use Cases
## Use Cases

### Git Operations and Configuration

Expand Down Expand Up @@ -2569,7 +2572,7 @@ client = OpenAI(
)
```

## 🚀 Deployment
## Deployment

### Deploy to Cloudflare Workers

Expand Down Expand Up @@ -2878,7 +2881,7 @@ try Droplets, Kubernetes, App Platform, and more:
acceleration. Performance depends on your server configuration and network
environment.

## 🔧 Configuration
## Configuration

### Configuration Parameters

Expand Down Expand Up @@ -2925,7 +2928,7 @@ const PLATFORM_PATH_TRANSFORMERS = {
};
```

## 🚧 Development
## Development

1. **Repository Setup**

Expand All @@ -2947,7 +2950,7 @@ const PLATFORM_PATH_TRANSFORMERS = {
npm run deploy # Deploy to production
```

## 🧪 Testing
## Testing

The repository includes a complete test suite to ensure code quality and
functional correctness.
Expand Down Expand Up @@ -2977,7 +2980,7 @@ npm run test:watch
- **Security Tests**: Input validation, security headers, permission control
- **Performance Tests**: Response time, memory usage, concurrent processing

## 🔍 Troubleshooting
## Troubleshooting

### Common Issues

Expand Down Expand Up @@ -3010,7 +3013,7 @@ Workers console:
npx wrangler dev --log-level debug
```

## ⚠️ Disclaimer
## Disclaimer

- **Legal and Compliant Use**: This repository aims to provide unified
acceleration services for code repositories, package registries, AI inference
Expand Down Expand Up @@ -3062,27 +3065,34 @@ npx wrangler dev --log-level debug
distribution, or modification of this repository constitutes acceptance of the
latest version of this disclaimer

## 🤝 Contributing

We welcome all forms of contribution! Please check the
[Contributing Guide](CONTRIBUTING.md) to learn how to participate in repository
development.
## Project Resources

Community and maintainer expectations are documented in:
We welcome all forms of contribution. Start with the
[Contributing Guide](CONTRIBUTING.md), and use these project documents when you
need the full collaboration and maintenance context:

- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Security Policy](SECURITY.md)
- [Governance](GOVERNANCE.md)

You can help by:

1. **Report Issues**: Use
[issue templates](https://github.com/xixu-me/Xget/issues/new/choose) to
report bugs or propose feature requests
2. **Submit Code**: Fork the repository, create a feature branch, submit a pull
request
3. **Improve Documentation**: Fix errors, add examples, improve descriptions
4. **Testing Feedback**: Test in different environments and provide feedback
report bugs or propose feature requests.
2. **Submit Code**: Fork the repository, create a feature branch, and open a
pull request.
3. **Improve Documentation**: Fix errors, add examples, and improve
explanations.
4. **Testing Feedback**: Validate Xget in different environments and share what
you learn.

Copyright © Xi Xu.

This repository is licensed under the AGPL-3.0 License. See
[`LICENSE`](LICENSE) for details.

## 🌟 Star History
## Star History

<a href="https://www.star-history.com/#xixu-me/Xget&Date">
<picture>
Expand All @@ -3092,13 +3102,6 @@ Community and maintainer expectations are documented in:
</picture>
</a>

## 📝 License

Copyright &copy; Xi Xu.

This repository is licensed under the AGPL-3.0 License - see the
[`LICENSE`](LICENSE) file for details.

---

<div align="center">
Expand Down
Loading
Loading