---
slug: "xget"
source_type: "readme"
source_url: "https://cdn.jsdelivr.net/gh/xixu-me/xget@main/README.md"
repo: "https://github.com/xixu-me/xget"
source_file: "README.md"
branch: "main"
---
# Xget đ
[](https://zread.ai/xixu-me/Xget)
[](https://deepwiki.com/xixu-me/xget)
[](https://codecov.io/github/xixu-me/xget)
[](#ecosystem-integration)
[](#ecosystem-integration)
[](#deploy-to-cloudflare-workers)
[](#deploy-to-edgeone-pages)
[](#deploy-to-vercel)
[](#deploy-to-netlify)
[](#deploy-to-deno-deploy)
[](#self-hosted-deployment)
[](#self-hosted-deployment)
**English** | [æąč¯īŧįŽäŊīŧ](https://github.com/xixu-me/xget/blob/HEAD/README.zh-Hans.md) |
[æŧĸčĒīŧįšéĢīŧ](https://github.com/xixu-me/xget/blob/HEAD/README.zh-Hant.md)
**Note**: Self-hosted deployment does not include global edge network
acceleration. Performance depends on your server configuration and network
environment.
## Configuration
### Configuration Parameters
You can customize configuration by modifying `src/config/index.js`:
```javascript
export const CONFIG = {
TIMEOUT_SECONDS: 30, // Request timeout (seconds)
MAX_RETRIES: 3, // Maximum retry count
RETRY_DELAY_MS: 1000, // Retry delay (milliseconds)
CACHE_DURATION: 300, // Fallback mutable cache duration (300 seconds = 5 minutes)
SECURITY: {
ALLOWED_METHODS: ['GET', 'HEAD'], // Base allowlist for regular requests; protocol traffic has broader built-in allowances
ALLOWED_ORIGINS: ['*'], // Allowed CORS origins
MAX_PATH_LENGTH: 2048 // Maximum path length (characters)
}
};
```
### Performance Tuning Recommendations
- **Cache Optimization**: Adjust the `CACHE_DURATION` fallback value based on
usage patterns; metadata and immutable artifacts use built-in policy TTLs
- **Timeout Settings**: Increase `TIMEOUT_SECONDS` appropriately for poor
network conditions
- **Retry Strategy**: Increase `MAX_RETRIES` and `RETRY_DELAY_MS` in
high-latency environments
### Adding New Platforms
To add support for new platforms, update the platform catalog and, if needed,
the path transformers:
```javascript
// src/config/platform-catalog.js
export const PLATFORM_CATALOG = {
// Existing platforms...
custom: 'https://example.com'
};
// src/routing/platform-transformers.js
const PLATFORM_PATH_TRANSFORMERS = {
custom: path => path.replace(/^\/custom\//, '/')
};
```
## Development
1. **Repository Setup**
```bash
git clone https://github.com/xixu-me/Xget.git
cd Xget
npm install
npx wrangler login # First time use
```
2. **Local Development**
```bash
npm run dev # Start development server (http://localhost:8787)
npm run test:run # Run complete test suite
npm run test:coverage # Generate test coverage report
npm run lint # Code linting
npm run format # Code formatting
npm run deploy # Deploy to production
```
## Testing
The repository includes a complete test suite to ensure code quality and
functional correctness.
### Complete Testing
```bash
# Install test dependencies
npm install
# Run all tests
npm run test:run
# Generate coverage report
npm run test:coverage
# Watch mode
npm run test:watch
```
### Test Coverage
- **Unit Tests**: Core functionality, platform configuration, performance
monitoring
- **Integration Tests**: End-to-end processes, platform integration, Git
protocol
- **Security Tests**: Input validation, security headers, permission control
- **Performance Tests**: Response time, memory usage, concurrent processing
## Troubleshooting
### Common Issues
**Q: No significant speed improvement?** A: Check if source files are already
cached at CDN edge nodes. Initial access may be slower, subsequent accesses will
be significantly faster.
**Q: Git operations failing?** A: Confirm correct URL format is used and Git
client version supports HTTPS proxy.
**Q: Cannot access after deployment?** A: Check if Cloudflare Workers domain is
correctly bound, confirm `wrangler.toml` configuration is correct.
**Q: Getting 400 error?** A: Check URL path format, confirm platform prefix is
correctly used.
### Performance Monitoring
Performance metrics are returned in response headers:
- `X-Performance-Metrics`: Contains timing statistics for request stages
- `X-Cache-Status`: Shows cache hit status
### Log Debugging
In development environment, you can view detailed logs through Cloudflare
Workers console:
```bash
npx wrangler dev --log-level debug
```
## Disclaimer
- **Legal and Compliant Use**: This repository aims to provide unified
acceleration services for code repositories, package registries, AI inference
APIs, container images, models, datasets, and other legitimate developer
resources. Users must strictly comply with the laws and regulations of their
jurisdiction and the terms of service of relevant platforms. Any illegal use
is the sole responsibility of the user
- **Non-Affiliation and Independent Responsibility**: This repository has no
affiliation, agency, or partnership relationship with any third-party
platforms. Any fork, secondary development, redistribution, or derivative
version based on this repository is solely the responsibility of its
maintainer; authors, maintainers, and contributors bear no legal or joint
liability for the actions or consequences of derivative repositories
- **No Warranty and Limitation of Liability**: To the maximum extent permitted
by applicable law, this repository is provided "AS IS" without any express or
implied warranties (including but not limited to merchantability, fitness for
a particular purpose, non-infringement, etc.). Authors, maintainers, and
contributors assume no responsibility for any direct or indirect losses
(including but not limited to data loss, business interruption, profit loss,
etc.) resulting from the use of this repository
- **Risk Assumption Principle**: Users should independently assess usage risks,
ensure their use is legal and compliant, respect third-party rights, and must
not use this repository for any illegal, infringing, malicious, or improper
purposes
- **Third-Party Platform Compliance**: Users must comply with the terms of
service, API usage policies, rate limits, and copyright requirements of
relevant platforms, and avoid causing overload or interference to source
platforms. Each platform has the final interpretation right over its content,
services, and policies
- **Intellectual Property Protection**: Content obtained through this repository
is protected by respective copyright laws. Users must comply with relevant
licensing agreements, copyright notices, and terms of use, and must not engage
in any activities that infringe intellectual property rights
- **Security Recommendations**: Although this repository adopts a no-log
architecture and does not store user request data, due to inherent risks of
internet transmission, users are advised to perform security scans on
downloaded content, especially for executable files and scripts
- **Open Source Nature**: This repository is open source. Authors and
contributors are not obligated to provide technical support, bug fixes, or
continuous maintenance. The inclusion of external contributions does not
constitute endorsement or commitment to specific uses or effects
- **Name Usage Guidelines**: Any representations that may imply authors or
contributors provide commercial cooperation, technical support, guarantees, or
endorsements are strictly prohibited. The use of repository names or author
identifiers must comply with relevant laws and regulations as well as general
norms
- **Disclaimer Updates**: This disclaimer may be updated and revised as the
repository develops or legal environments change. Continued use, copying,
distribution, or modification of this repository constitutes acceptance of the
latest version of this disclaimer
## Project Resources
We welcome all forms of contribution. Start with the
[Contributing Guide](https://github.com/xixu-me/xget/blob/HEAD/CONTRIBUTING.md), and use these project documents when you
need the full collaboration and maintenance context:
- [Code of Conduct](https://github.com/xixu-me/xget/blob/HEAD/CODE_OF_CONDUCT.md)
- [Security Policy](https://github.com/xixu-me/xget/blob/HEAD/SECURITY.md)
- [Governance](https://github.com/xixu-me/xget/blob/HEAD/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, 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`](https://github.com/xixu-me/xget/tree/HEAD/LICENSE) for details.
## Star History
---
**If this repository helps you, please consider giving it a â star!**
Made with â¤ī¸ by [Xi Xu](https://xi-xu.me)
[](https://dartnode.com 'Powered by DartNode - Free VPS for Open Source')