Xget

https://github.com/xixu-me/xget
Admin
Xget is an ultra-high performance, secure, one-stop developer resource acceleration engine that...
Tokens:41,153
Snippets:180
Trust Score:9.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Flatpak Usage Examples with Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Demonstrates how to verify the Flathub remote URL, list remote contents, install apps, and troubleshoot using xget as the mirror.

```bash
# Verify that the saved remote URL now points to Xget
flatpak remotes --show-details

# Inspect remote contents
flatpak remote-ls flathub

# Install an app after repointing the Flathub remote
flatpak install flathub org.gnome.gedit

# Install directly from a rewritten .flatpakref
flatpak install --from \
  https://xget.xi-xu.me/flathub/repo/appstream/org.gnome.gedit.flatpakref

# Print libcurl HTTP traces when troubleshooting
OSTREE_DEBUG_HTTP=1 flatpak remote-ls flathub

# Update installed apps and runtimes
flatpak update
```

--------------------------------

### Repository Setup and Dependencies

Source: https://github.com/xixu-me/xget/blob/main/README.md

Clone the Xget repository, install Node.js dependencies using npm, and log in to Wrangler for deployment. This is the initial step for local development.

```bash
git clone https://github.com/xixu-me/Xget.git
cd Xget
npm install
npx wrangler login  # First time use
```

--------------------------------

### List Dependencies in cpanfile for Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Example of a cpanfile specifying dependencies and how to install them using cpanm with the Xget mirror.

```perl
# List dependencies in cpanfile
requires 'DBI';
requires 'Mojolicious';
requires 'JSON';

# Then install using Xget mirror
cpanm --mirror https://xget.xi-xu.me/cpan/ --installdeps .
```

--------------------------------

### Install Packages with Homebrew

Source: https://github.com/xixu-me/xget/blob/main/README.md

Use the 'brew install' command to install packages after configuring Homebrew to use Xget mirrors.

```bash
# Install packages
brew install git
```

--------------------------------

### Install Docker and Docker Compose on Ubuntu

Source: https://github.com/xixu-me/xget/blob/main/docs/deploy-on-digitalocean.md

Installs the Docker engine and the Docker Compose plugin on an Ubuntu system.

```bash
# Update system
sudo apt update && sudo apt upgrade -y

# Install dependencies
sudo apt install -y ca-certificates curl gnupg

# Docker’s official GPG key and repo
sudo install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | \
  sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg

echo \
  "deb [arch=$(dpkg --print-architecture) \
  signed-by=/etc/apt/keyrings/docker.gpg] \
  https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

sudo apt update
sudo apt install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin

# Allow current user to run docker without sudo (optional)
sudo usermod -aG docker $USER
```

--------------------------------

### Proxy URL Conversion Examples

Source: https://context7.com/xixu-me/xget/llms.txt

Common command-line and configuration patterns for routing traffic through the Xget proxy.

```bash
# GitHub file download
# Original: https://github.com/microsoft/vscode/archive/main.zip
# Accelerated: https://xget.example.com/gh/microsoft/vscode/archive/main.zip
curl -L -O https://xget.example.com/gh/microsoft/vscode/archive/main.zip

# Git clone through Xget
git clone https://xget.example.com/gh/microsoft/vscode.git

# npm package acceleration
npm install --registry https://xget.example.com/npm/

# PyPI package acceleration
pip install requests -i https://xget.example.com/pypi/simple/

# Hugging Face model download
curl -L -O https://xget.example.com/hf/microsoft/DialoGPT-medium/resolve/main/pytorch_model.bin

# Docker image pull
docker pull xget.example.com/cr/docker/library/nginx:latest

# OpenAI API acceleration (in code, set base_url)
# base_url="https://xget.example.com/ip/openai/v1"

# Go module proxy
export GOPROXY=https://xget.example.com/golang,direct
go mod download

# Maven repository mirror (in settings.xml)
# <url>https://xget.example.com/maven/maven2</url>

# arXiv paper download
wget https://xget.example.com/arxiv/pdf/2301.07041.pdf
```

--------------------------------

### Install Ruby Gems with Bundle Using Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Commands to configure Bundler to use the Xget mirror and install project dependencies.

```bash
# Install using bundle
bundle config mirror.https://rubygems.org https://xget.xi-xu.me/rubygems/
bundle install
```

--------------------------------

### Start Development Server

Source: https://github.com/xixu-me/xget/blob/main/CLAUDE.md

Runs the Cloudflare Workers local development environment on http://localhost:8787.

```bash
npm run dev
```

--------------------------------

### Start Xget Service

Source: https://github.com/xixu-me/xget/blob/main/docs/deploy-on-digitalocean.md

Starts the Xget container in detached mode using Docker Compose.

```bash
docker compose up -d
```

--------------------------------

### Usage Example for Civitai Model Download

Source: https://github.com/xixu-me/xget/blob/main/README.md

Demonstrates how to use the get_model_info and download_model functions to retrieve and download a model from Civitai.

```python
# Usage example
model_id = 7240  # Example model ID
model_info = get_model_info(model_id)
print(f"Model name: {model_info['name']}")

# Download first model version
if model_info['modelVersions']:
    version_id = model_info['modelVersions'][0]['id']
    download_model(version_id, f"model_{version_id}.safetensors")
```

--------------------------------

### Install Nginx and Certbot

Source: https://github.com/xixu-me/xget/blob/main/docs/deploy-on-digitalocean.md

Install the necessary packages for web serving and SSL certificate management on a Debian-based system.

```bash
sudo apt install -y nginx certbot python3-certbot-nginx
```

--------------------------------

### Install TeX Packages During Compilation

Source: https://github.com/xixu-me/xget/blob/main/README.md

Example of how to enable automatic installation of missing TeX packages during LaTeX document compilation using --shell-escape.

```bash
# Automatically install missing packages during LaTeX document compilation
pdflatex --shell-escape document.tex

# Or manually install specific packages
tlmgr install caption
tlmgr install subcaption
tlmgr install algorithm2e
```

--------------------------------

### Run Complete Test Suite

Source: https://github.com/xixu-me/xget/blob/main/README.md

Install test dependencies and execute the full test suite using npm. This includes commands for running all tests, generating coverage reports, and enabling watch mode.

```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
```

--------------------------------

### Deploy with Docker Compose / Podman Compose

Source: https://github.com/xixu-me/xget/blob/main/README.md

Commands to start and manage the Xget service using Docker Compose or Podman Compose based on the defined `docker-compose.yml` file. The service will be accessible on port 8080.

```bash
docker compose up -d
```

```bash
podman compose up -d
```

--------------------------------

### Install Perl Modules with cpanm Using Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Commands to install the cpanm tool and use it with the Xget mirror to install Perl modules and dependencies.

```bash
# Install cpanm (if not available)
curl -L https://cpanmin.us | perl - --sudo App::cpanminus

# Install modules using Xget mirror
cpanm --mirror https://xget.xi-xu.me/cpan/ DBI
cpanm --mirror https://xget.xi-xu.me/cpan/ Mojolicious

# Install dependencies from Makefile.PL
cpanm --mirror https://xget.xi-xu.me/cpan/ --installdeps .
```

--------------------------------

### Configure MiKTeX to Use Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Commands for configuring MiKTeX on Windows to use the Xget CTAN mirror for package installations.

```bash
# Windows MiKTeX configuration
mpm --set-repository=https://xget.xi-xu.me/ctan/systems/win32/miktex

# Update package database
mpm --update-db

# Install packages
mpm --install=beamer
mpm --install=pgf
```

--------------------------------

### Configure Project-Level R Mirror with renv

Source: https://github.com/xixu-me/xget/blob/main/README.md

Example of specifying the Xget CRAN mirror for a project using the renv package manager.

```r
# Specify mirror in project's renv.lock or script
renv::init()
renv::settings$repos.override(c(CRAN = "https://xget.xi-xu.me/cran/"))

# Install packages
install.packages(c("dplyr", "ggplot2", "tidyr"))

# Or use pak package manager
pak::pkg_install("tidyverse", repos = "https://xget.xi-xu.me/cran/")
```

--------------------------------

### Configure Project-Level RubyGems Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Example of how to specify the Xget mirror for RubyGems within a project's Gemfile.

```ruby
# Configure project-level mirror in Gemfile
source 'https://xget.xi-xu.me/rubygems/'

gem 'rails', '~> 7.0.0'
gem 'pg', '~> 1.1'
gem 'puma', '~> 5.0'
```

--------------------------------

### Configure R to Use Xget CRAN Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Instructions for temporarily and globally configuring R to use the Xget CRAN mirror for package installations.

```r
# Temporarily use Xget CRAN mirror in R
install.packages("ggplot2", repos = "https://xget.xi-xu.me/cran/")
```

```r
# Globally configure CRAN mirror
options(repos = c(CRAN = "https://xget.xi-xu.me/cran/"))
```

```r
# Verify configuration
getOption("repos")
```

--------------------------------

### Pull and Run Pre-built Docker Image

Source: https://github.com/xixu-me/xget/blob/main/README.md

Use these commands to pull the latest Xget Docker image from GitHub Container Registry and run it as a container. Ensure Docker or Podman is installed and configured.

```bash
# Pull the latest image
docker pull ghcr.io/xixu-me/xget:latest

# Run the container
docker run -d \
  --name xget \
  -p 8080:8080 \
  ghcr.io/xixu-me/xget:latest
```

```bash
# Pull the latest image
podman pull ghcr.io/xixu-me/xget:latest

# Run the container
podman run -d \
  --name xget \
  -p 8080:8080 \
  ghcr.io/xixu-me/xget:latest
```

--------------------------------

### Configure npm to Use Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Commands to temporarily or globally configure npm to use the Xget mirror for faster package installations.

```bash
# Temporarily use Xget mirror
npm install --registry https://xget.xi-xu.me/npm/

# Globally configure npm mirror
npm config set registry https://xget.xi-xu.me/npm/

# Verify configuration
npm config get registry
```

--------------------------------

### Local Development Commands

Source: https://github.com/xixu-me/xget/blob/main/README.md

Run these npm scripts for local development tasks, including starting the development server, running tests, linting, formatting, and deploying.

```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
```

--------------------------------

### Configure RubyGems to Use Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Instructions for temporarily and globally configuring RubyGems to use the Xget mirror for package installations.

```bash
# Temporarily use Xget mirror
gem install rails --source https://xget.xi-xu.me/rubygems/
```

```bash
# Globally configure RubyGems mirror
gem sources --add https://xget.xi-xu.me/rubygems/
gem sources --remove https://rubygems.org/
```

```bash
# Verify configuration
gem sources -l
```

--------------------------------

### Configure conda to Use Xget Channels

Source: https://github.com/xixu-me/xget/blob/main/README.zh-Hans.md

Set up conda to use Xget mirrors for its default and community channels. This accelerates package downloads and installations for conda environments.

```bash
# Configure default channel mirrors
conda config --add default_channels https://xget.xi-xu.me/conda/pkgs/msys2
conda config --add default_channels https://xget.xi-xu.me/conda/pkgs/r
conda config --add default_channels https://xget.xi-xu.me/conda/pkgs/main

# Configure all community channel mirrors (recommended)
conda config --set channel_alias https://xget.xi-xu.me/conda/community

# Or configure specific community channels
conda config --add channels https://xget.xi-xu.me/conda/community/conda-forge
conda config --add channels https://xget.xi-xu.me/conda/community/bioconda

# Set channel priority
conda config --set channel_priority strict

# Verify configuration
conda config --show
```

--------------------------------

### Configure npm/Bun to Use Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.zh-Hans.md

Configure project-level npm/Bun registry mirrors by creating or appending to the .npmrc file. This affects subsequent npm or Bun install commands.

```bash
# Configure project-level mirror in .npmrc (npm / Bun reusable)
echo "registry=https://xget.xi-xu.me/npm/" > .npmrc

# Install dependencies with npm
npm install

# Install dependencies with Bun
bun install
```

--------------------------------

### Configure pip to Use Xget PyPI Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.zh-Hans.md

Temporarily or globally configure pip to use the Xget PyPI mirror for faster package installations. Ensure the host is trusted.

```bash
# Temporarily use Xget mirror
pip install requests -i https://xget.xi-xu.me/pypi/simple/

# Globally configure pip mirror
pip config set global.index-url https://xget.xi-xu.me/pypi/simple/
pip config set global.trusted-host xget.xi-xu.me

# Verify configuration
pip config list
```

--------------------------------

### Configure pip Mirror in Project Files

Source: https://github.com/xixu-me/xget/blob/main/README.md

Sets up the Xget mirror for pip by creating a pip.conf file, either in the user's home directory or the project root.

```bash
# Create pip.conf file (Linux/macOS)
mkdir -p ~/.pip
cat > ~/.pip/pip.conf << EOF
[global]
index-url = https://xget.xi-xu.me/pypi/simple/
trusted-host = xget.xi-xu.me
EOF

# Or create pip.conf in project root directory
cat > pip.conf << EOF
[global]
index-url = https://xget.xi-xu.me/pypi/simple/
trusted-host = xget.xi-xu.me
EOF

# Install using configuration file
pip install -r requirements.txt --config-file pip.conf
```

--------------------------------

### Use Xget Mirror in Project (npm / Bun)

Source: https://github.com/xixu-me/xget/blob/main/README.md

Sets up the Xget mirror for a project by creating a .npmrc file, compatible with both npm and Bun.

```bash
# Configure project-level mirror in .npmrc (.npmrc can be reused by npm / Bun)
echo "registry=https://xget.xi-xu.me/npm/" > .npmrc

# Install dependencies with npm
npm install

# Install dependencies with Bun
bun install
```

--------------------------------

### Dockerfile 优化基础镜像拉取

Source: https://github.com/xixu-me/xget/blob/main/README.zh-Hans.md

在 Dockerfile 中使用 `FROM` 指令指定 Xget 加速的镜像源，以提高构建过程中的基础镜像拉取速度。支持多阶段构建。

```dockerfile
# 在 Dockerfile 中使用 Xget 加速基础镜像
FROM xget.xi-xu.me/cr/ghcr/nodejs/node:18-alpine AS builder

WORKDIR /app
COPY package*.json ./
RUN npm install

COPY . .
RUN npm run build

# 生产阶段
FROM xget.xi-xu.me/cr/ghcr/nginxinc/nginx-unprivileged:latest
COPY --from=builder /app/dist /usr/share/nginx/html

# 使用微软容器注册表的 .NET 镜像
FROM xget.xi-xu.me/cr/mcr/dotnet/aspnet:8.0 AS runtime
WORKDIR /app
COPY --from=builder /app/publish .
ENTRYPOINT ["dotnet", "MyApp.dll"]

```

--------------------------------

### Kubernetes 部署配置使用加速镜像

Source: https://github.com/xixu-me/xget/blob/main/README.zh-Hans.md

在 Kubernetes 的 `deployment.yaml` 文件中指定使用 Xget 加速的容器镜像。这可以显著提高集群节点拉取镜像的速度。

```yaml
# deployment.yaml - 使用 Xget 的镜像
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
spec:
  replicas: 3
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
        - name: nginx
          image: xget.xi-xu.me/cr/ghcr/nginxinc/nginx-unprivileged:latest
          ports:
            - containerPort: 80
        - name: redis
          image: xget.xi-xu.me/cr/ghcr/bitnami/redis:alpine
          ports:
            - containerPort: 6379

```

--------------------------------

### Configure Global Gradle Mirror in init.gradle

Source: https://github.com/xixu-me/xget/blob/main/README.md

Set up global Gradle mirrors in ~/.gradle/init.gradle for all projects to use Xget repositories.

```gradle
// Configure global mirror in ~/.gradle/init.gradle
allprojects {
    repositories {
        maven {
            url 'https://xget.xi-xu.me/maven/maven2'
        }
    }
}

settingsEvaluated {
    settings.pluginManagement {
        repositories {
            maven {
                url 'https://xget.xi-xu.me/gradle/m2'
            }
            gradlePluginPortal()
        }
    }
}
```

--------------------------------

### Install R Packages Using Rscript with Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Commands to install R packages using Rscript, specifying the Xget CRAN mirror.

```bash
# Install packages using R script in command line
Rscript -e "options(repos = c(CRAN = 'https://xget.xi-xu.me/cran/')); install.packages('ggplot2')"
```

```bash
# Batch install packages
Rscript -e "
options(repos = c(CRAN = 'https://xget.xi-xu.me/cran/'))
packages <- c('dplyr', 'ggplot2', 'tidyr', 'readr')
install.packages(packages)
"
```

--------------------------------

### Homebrew Package Management

Source: https://github.com/xixu-me/xget/blob/main/README.md

Basic commands for searching, updating, and listing installed Homebrew packages.

```bash
# Search packages
brew search python
```

```bash
# Update packages
brew upgrade
```

```bash
# View installed packages
brew list
```

--------------------------------

### Build and Run Docker Image from Source

Source: https://github.com/xixu-me/xget/blob/main/README.md

Clone the repository, build the Docker image locally, and then run it as a container. This method is useful for development or when using a specific version not yet published.

```bash
# Clone the repository
git clone https://github.com/xixu-me/Xget.git
cd Xget

# Build the image
docker build -t xget:local .

# Run the container
docker run -d \
  --name xget \
  -p 8080:8080 \
  xget:local
```

```bash
# Clone the repository
git clone https://github.com/xixu-me/Xget.git
cd Xget

# Build the image
podman build -t xget:local .

# Run the container
podman run -d \
  --name xget \
  -p 8080:8080 \
  xget:local
```

--------------------------------

### Get F-Droid App Information

Source: https://github.com/xixu-me/xget/blob/main/README.md

Retrieves information about a specific app from the F-Droid API using curl.

```bash
# Get app information
curl https://xget.xi-xu.me/fdroid/api/v1/packages/org.fdroid.fdroid
```

--------------------------------

### Get Jenkins Update Center Information

Source: https://github.com/xixu-me/xget/blob/main/README.md

Retrieve the Jenkins update center JSON file using curl.

```bash
curl https://xget.xi-xu.me/jenkins/update-center.json
```

--------------------------------

### Configuration Factory Usage

Source: https://context7.com/xixu-me/xget/llms.txt

Demonstrates accessing default configuration values and creating custom configurations using environment variable overrides.

```javascript
import { createConfig, CONFIG } from './src/config/index.js';

// Use default configuration
console.log(CONFIG.TIMEOUT_SECONDS);     // 30
console.log(CONFIG.MAX_RETRIES);          // 3
console.log(CONFIG.RETRY_DELAY_MS);       // 1000
console.log(CONFIG.CACHE_DURATION);       // 1800 (30 minutes)
console.log(CONFIG.SECURITY.ALLOWED_METHODS);  // ['GET', 'HEAD']
console.log(CONFIG.SECURITY.ALLOWED_ORIGINS);  // ['*']
console.log(CONFIG.SECURITY.MAX_PATH_LENGTH);  // 2048

// Create config with environment overrides (Cloudflare Workers)
const env = {
  TIMEOUT_SECONDS: '60',
  MAX_RETRIES: '5',
  RETRY_DELAY_MS: '2000',
  CACHE_DURATION: '3600',
  ALLOWED_METHODS: 'GET,HEAD,POST',
  ALLOWED_ORIGINS: 'https://example.com,https://app.example.com',
  MAX_PATH_LENGTH: '4096'
};
const config = createConfig(env);

console.log(config.TIMEOUT_SECONDS);      // 60
console.log(config.MAX_RETRIES);           // 5
console.log(config.CACHE_DURATION);        // 3600 (1 hour)
console.log(config.SECURITY.ALLOWED_ORIGINS); // ['https://example.com', 'https://app.example.com']

// Access platform mappings
console.log(config.PLATFORMS.gh);    // 'https://github.com'
console.log(config.PLATFORMS.npm);   // 'https://registry.npmjs.org'
console.log(config.PLATFORMS.hf);    // 'https://huggingface.co'
```

--------------------------------

### Configure Homebrew to Use Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Set Homebrew environment variables to point to Xget mirrors for brew, core, API, and bottles. Run 'brew update' to apply changes.

```bash
# Set Homebrew environment variables to use Xget mirror
export HOMEBREW_BREW_GIT_REMOTE="https://xget.xi-xu.me/homebrew/brew.git"
export HOMEBREW_CORE_GIT_REMOTE="https://xget.xi-xu.me/homebrew/homebrew-core.git"
export HOMEBREW_API_DOMAIN="https://xget.xi-xu.me/homebrew/api"
export HOMEBREW_BOTTLE_DOMAIN="https://xget.xi-xu.me/homebrew/bottles"

# Update Homebrew
brew update
```

--------------------------------

### Get Civitai Model Information

Source: https://github.com/xixu-me/xget/blob/main/README.md

Fetches information about a Civitai model using its ID. Requires the 'requests' library.

```python
def get_model_info(model_id):
    """Get Civitai model information"""
    url = f"{base_url}/api/v1/models/{model_id}"
    response = requests.get(url)
    return response.json()
```

--------------------------------

### Update Package Cache (DNF)

Source: https://github.com/xixu-me/xget/blob/main/README.md

Updates the DNF package manager cache. This command is typically run before installing or updating packages.

```bash
sudo dnf makecache
```

--------------------------------

### Create Xget Directory

Source: https://github.com/xixu-me/xget/blob/main/docs/deploy-on-digitalocean.md

Creates a dedicated directory for the Xget configuration files.

```bash
mkdir -p ~/xget && cd ~/xget
```

--------------------------------

### 直接拉取加速的容器镜像

Source: https://github.com/xixu-me/xget/blob/main/README.zh-Hans.md

使用 `docker pull` 命令直接从 Xget 加速的容器注册表中拉取镜像。支持 GitHub、Google 和 Microsoft 的容器注册表。

```bash
# 拉取 GitHub 容器注册表镜像
docker pull xget.xi-xu.me/cr/ghcr/nginxinc/nginx-unprivileged:latest

# 拉取谷歌容器注册表镜像
docker pull xget.xi-xu.me/cr/gcr/distroless/base:latest

# 拉取微软容器注册表镜像
docker pull xget.xi-xu.me/cr/mcr/dotnet/runtime:8.0

```

--------------------------------

### Configure pip with pip.conf for Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.zh-Hans.md

Set up pip to use the Xget PyPI mirror by creating a pip.conf file. This can be done for the user's home directory or within a specific project.

```bash
# Create pip.conf file (Linux/macOS)
mkdir -p ~/.pip
cat > ~/.pip/pip.conf << EOF
[global]
index-url = https://xget.xi-xu.me/pypi/simple/
trusted-host = xget.xi-xu.me
EOF

# Or create pip.conf in the project root
cat > pip.conf << EOF
[global]
index-url = https://xget.xi-xu.me/pypi/simple/
trusted-host = xget.xi-xu.me
EOF

# Install using the configuration file
pip install -r requirements.txt --config-file pip.conf
```

--------------------------------

### Deploy to Production

Source: https://github.com/xixu-me/xget/blob/main/CLAUDE.md

Deploys the Xget project to Cloudflare Workers production.

```bash
npm run deploy
```

--------------------------------

### Manage Go Project Dependencies

Source: https://github.com/xixu-me/xget/blob/main/README.md

Common Go commands for downloading, updating, and cleaning the module cache.

```bash
# Download dependencies
go mod download

# Update dependencies
go get -u ./...

# Clean module cache
go clean -modcache
```

--------------------------------

### Configure Global CRAN Mirror in .Rprofile

Source: https://github.com/xixu-me/xget/blob/main/README.md

Example of setting global CRAN and Bioconductor mirrors, along with the download method, in the .Rprofile file.

```r
# Configure global mirror in .Rprofile file in user home directory
options(repos = c(
  CRAN = "https://xget.xi-xu.me/cran/",
  BioCsoft = "https://bioconductor.org/packages/release/bioc",
  BioCann = "https://bioconductor.org/packages/release/data/annotation",
  BioCexp = "https://bioconductor.org/packages/release/data/experiment"
))

# Set download method
options(download.file.method = "libcurl")
```

--------------------------------

### Configure Bun to Use Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Configuration for Bun to use the Xget mirror, either project-level via bunfig.toml or globally. Also shows how to use .npmrc.

```toml
# bunfig.toml (project-level) or ~/.bunfig.toml (global)
[install]
registry = "https://xget.xi-xu.me/npm/"
```

```bash
# Install dependencies with Bun
bun install

# Bun also supports .npmrc, so you can reuse existing npm registry settings
echo "registry=https://xget.xi-xu.me/npm/" > .npmrc
bun install
```

--------------------------------

### File Organization Structure

Source: https://github.com/xixu-me/xget/blob/main/CLAUDE.md

Illustrates the directory structure of the Xget project, detailing the purpose of key files and directories within `src/` and `test/`.

```tree
src/
├── index.js                 # Main Worker entry point
├── app/
│   ├── handle-request.js    # Shared request pipeline
│   └── request-context.js   # Protocol-aware request classification
├── config/
│   ├── index.js             # Runtime configuration
│   ├── platform-catalog.js  # Platform base URLs
│   └── platforms.js         # Compatibility exports
├── protocols/
│   ├── git.js               # Git protocol handler
│   ├── docker.js            # Docker/OCI handler
│   └── ai.js                # AI inference handler
├── response/
│   └── finalize-response.js # Response shaping and cache writes
├── routing/
│   ├── platform-index.js    # Platform matching order
│   ├── platform-transformers.js
│   └── resolve-target.js    # Upstream target resolution
├── upstream/
│   ├── cache.js             # Cache read helpers
│   └── fetch-upstream.js    # Upstream transport and retries
└── utils/
    ├── validation.js        # Request validation
    ├── security.js          # Security utilities
    └── performance.js       # Performance monitoring

test/
├── features/               # Feature tests
├── platforms/              # Platform-specific tests
├── unit/                   # Unit tests
├── index.test.js          # Core Worker tests
└── integration.test.js    # Integration tests
```

--------------------------------

### Use Xget Mirror in conda Environment File

Source: https://github.com/xixu-me/xget/blob/main/README.md

Specifies Xget mirror URLs directly within a conda environment.yml file for package installation.

```yaml
# environment.yml
name: myproject
channels:
  - https://xget.xi-xu.me/conda/pkgs/main
  - https://xget.xi-xu.me/conda/pkgs/r
  - https://xget.xi-xu.me/conda/community/bioconda
  - https://xget.xi-xu.me/conda/community/conda-forge
dependencies:
  - python=3.11
  - numpy>=1.24.0
  - pandas>=2.0.0
  - matplotlib>=3.7.0
  - scipy>=1.10.0
  - pip
  - pip:
      - requests>=2.28.0
```

```bash
# Create environment using environment file
conda env create -f environment.yml

# Update environment
conda env update -f environment.yml
```

--------------------------------

### Docker Compose 配置使用加速镜像

Source: https://github.com/xixu-me/xget/blob/main/README.zh-Hans.md

在 `docker-compose.yml` 文件中配置使用 Xget 加速的容器镜像，以优化本地开发和多容器应用的部署速度。

```yaml
# docker-compose.yml - 使用 Xget 加速镜像
version: '3.8'
services:
  web:
    image: xget.xi-xu.me/cr/ghcr/nginxinc/nginx-unprivileged:latest
    ports:
      - '80:80'
    volumes:
      - ./html:/usr/share/nginx/html

  database:
    image: xget.xi-xu.me/cr/mcr/mssql/server:2022-latest
    environment:
      ACCEPT_EULA: Y
      SA_PASSWORD: 'MyStrongPassword123!'
    volumes:
      - mssql_data:/var/opt/mssql

  cache:
    image: xget.xi-xu.me/cr/ghcr/bitnami/redis:alpine
    ports:
      - '6379:6379'

volumes:
  mssql_data:

```

--------------------------------

### Enable Debug Logging with Wrangler

Source: https://github.com/xixu-me/xget/blob/main/README.md

Use this command to enable detailed debug logs in the Cloudflare Workers console during development. Ensure you have Wrangler installed and configured.

```bash
npx wrangler dev --log-level debug
```

--------------------------------

### Configure NuGet to Use Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Commands to add the Xget NuGet v3 source and use it for restoring project packages.

```bash
# Add Xget package source
dotnet nuget add source https://xget.xi-xu.me/nuget/v3/index.json -n xget

# List package sources
dotnet nuget list source

# Use in project
dotnet restore --source https://xget.xi-xu.me/nuget/v3/index.json
```

--------------------------------

### Batch Download F-Droid Apps

Source: https://github.com/xixu-me/xget/blob/main/README.md

Creates and executes a bash script to batch download a list of F-Droid apps into a specified directory. Requires 'wget' to be installed.

```bash
# Create app download script
cat > download_fdroid_apps.sh << 'EOF'
#!/bin/bash

# Define list of apps to download
apps=(
    "org.fdroid.fdroid_1016050.apk"
    "org.mozilla.fennec_fdroid_1014000.apk"
    "com.termux_1180.apk"
    "org.videolan.vlc_13050399.apk"
)

# Create download directory
mkdir -p fdroid_apps

# Batch download apps
for app in "${apps[@]}"; do
    echo "Downloading: $app"
    wget -P fdroid_apps "https://xget.xi-xu.me/fdroid/repo/$app"
done

echo "All apps downloaded!"
EOF

chmod +x download_fdroid_apps.sh
./download_fdroid_apps.sh
```

--------------------------------

### Configure Go to Use Xget Proxy

Source: https://github.com/xixu-me/xget/blob/main/README.md

Instructions for setting environment variables to configure Go modules to use the Xget proxy and disable checksum verification.

```bash
# Configure Go module proxy
export GOPROXY=https://xget.xi-xu.me/golang,direct
export GOSUMDB=off

# Or permanently configure
go env -w GOPROXY=https://xget.xi-xu.me/golang,direct
go env -w GOSUMDB=off

# Verify configuration
go env GOPROXY
```

--------------------------------

### Docker Compose Configuration

Source: https://github.com/xixu-me/xget/blob/main/README.md

Define Xget service configuration in a `docker-compose.yml` file for easy deployment. This setup uses the pre-built image and maps port 8080.

```yaml
version: '3.8'

services:
  xget:
    image: ghcr.io/xixu-me/xget:latest
    container_name: xget
    ports:
      - '8080:8080'
    restart: unless-stopped
```

--------------------------------

### Configure Xget with Environment Variables

Source: https://github.com/xixu-me/xget/blob/main/README.md

Set environment variables in a .env file to configure the base URLs for various AI services, including OpenAI, Anthropic, Gemini, Cohere, Mistral AI, and Groq. These variables are automatically picked up by the SDKs.

```bash
# Configure in .env file
OPENAI_BASE_URL=https://xget.xi-xu.me/ip/openai
ANTHROPIC_BASE_URL=https://xget.xi-xu.me/ip/anthropic
GEMINI_BASE_URL=https://xget.xi-xu.me/ip/gemini
COHERE_BASE_URL=https://xget.xi-xu.me/ip/cohere
MISTRAL_AI_BASE_URL=https://xget.xi-xu.me/ip/mistralai
GROQ_BASE_URL=https://xget.xi-xu.me/ip/groq

```

--------------------------------

### Convert SourceForge URL to xget format

Source: https://github.com/xixu-me/xget/blob/main/README.md

Add the 'sf' prefix to SourceForge download URLs for xget compatibility.

```url
# Original URL
https://sourceforge.net/projects/sevenzip/files/7-Zip/23.01/7z2301-x64.exe/download

# Converted (add sf prefix)
https://xget.xi-xu.me/sf/projects/sevenzip/files/7-Zip/23.01/7z2301-x64.exe/download
```

--------------------------------

### Run common development commands

Source: https://github.com/xixu-me/xget/blob/main/CONTRIBUTING.md

Use these commands for local development, linting, formatting, and testing.

```bash
npm run dev
npm run lint
npm run format:check
npm run test:run
npm run test:coverage
npm run type-check
```

--------------------------------

### Accelerate AI API Calls in JavaScript/Node.js

Source: https://github.com/xixu-me/xget/blob/main/README.md

Use Xget to accelerate API calls to OpenAI, Anthropic, and Gemini by configuring the client with the Xget baseURL. Ensure you have the respective SDKs installed.

```javascript
// OpenAI API acceleration
import OpenAI from 'openai';

const openaiClient = new OpenAI({
  apiKey: 'your-openai-api-key',
  baseURL: 'https://xget.xi-xu.me/ip/openai/v1' // Use Xget
});

async function chatWithGPT() {
  const response = await openaiClient.responses.create({
    model: 'gpt-5.1',
    input: 'Hello, GPT!'
  });

  console.log(response.output_text);
}

// Claude API acceleration
import Anthropic from '@anthropic-ai/sdk';

const anthropicClient = new Anthropic({
  apiKey: 'your-claude-api-key',
  baseURL: 'https://xget.xi-xu.me/ip/anthropic' // Use Xget
});

async function chatWithClaude() {
  const message = await anthropicClient.messages.create({
    model: 'claude-sonnet-4-5',
    max_tokens: 256,
    messages: [
      {
        role: 'user',
        content: 'Hello, Claude!'
      }
    ]
  });

  console.log(message.content[0].text);
}

// Gemini API acceleration
import { GoogleGenAI } from '@google/genai';

const geminiClient = new GoogleGenAI({
  apiKey: 'your-gemini-api-key'
});

async function chatWithGemini() {
  const response = await geminiClient.models.generateContent({
    model: 'gemini-3-pro-preview',
    contents: 'Hello, Gemini!',
    config: {
      httpOptions: {
        baseUrl: 'https://xget.xi-xu.me/ip/gemini' // Use Xget
      }
    }
  });

  console.log(response.text);
}

```

--------------------------------

### Configure Debian/Ubuntu APT for Xget Mirror

Source: https://github.com/xixu-me/xget/blob/main/README.md

Update your APT sources list to use xget as a mirror for Debian and Ubuntu repositories. Includes commands for backing up the original list and updating the package index.

```bash
# Backup original source list
sudo cp /etc/apt/sources.list /etc/apt/sources.list.backup

# Configure Debian mirror
echo "deb https://xget.xi-xu.me/debian/debian bookworm main" | sudo tee /etc/apt/sources.list
echo "deb https://xget.xi-xu.me/debian/debian-security bookworm-security main" | sudo tee -a /etc/apt/sources.list

# Configure Ubuntu mirror
echo "deb https://xget.xi-xu.me/ubuntu/ubuntu jammy main restricted universe multiverse" | sudo tee /etc/apt/sources.list
echo "deb https://xget.xi-xu.me/ubuntu/ubuntu jammy-updates main restricted universe multiverse" | sudo tee -a /etc/apt/sources.list

# Update package list
sudo apt update
```

--------------------------------

### Configure openSUSE Zypper Mirrors

Source: https://github.com/xixu-me/xget/blob/main/README.md

Configures Zypper package manager to use Xget mirrors for openSUSE Leap and Tumbleweed. Includes commands to add the repository, refresh sources, and verify the configuration.

```bash
# Configure openSUSE Leap mirror
sudo zypper mr -d repo-oss
sudo zypper ar -f https://xget.xi-xu.me/opensuse/distribution/leap/15.5/repo/oss/ repo-oss-xget

# Configure openSUSE Tumbleweed mirror
sudo zypper mr -d repo-oss
sudo zypper ar -f https://xget.xi-xu.me/opensuse/tumbleweed/repo/oss/ repo-oss-xget

# Refresh software sources
sudo zypper refresh

# Verify configuration
sudo zypper lr -u
```

--------------------------------

### Implement Edge Caching

Source: https://context7.com/xixu-me/xget/llms.txt

Utilizes the Cloudflare Cache API to cache GET and HEAD requests. Caching is automatically bypassed for sensitive or stateful requests like Git, Docker, or authenticated API calls.

```javascript
import { getDefaultCache, tryReadCachedResponse } from './src/upstream/cache.js';
import { PerformanceMonitor } from './src/utils/performance.js';

// Get the default Cloudflare cache
const cache = getDefaultCache();  // Cache object or null outside Workers

// Try to read from cache before upstream fetch
const request = new Request('https://xget.example.com/npm/lodash');
const monitor = new PerformanceMonitor();

const cachedResponse = await tryReadCachedResponse({
  cache,
  cacheTargetUrl: 'https://registry.npmjs.org/lodash',
  canUseCache: true,
  hasSensitiveHeaders: false,  // No Authorization/Cookie/Proxy-Authorization
  monitor,
  request,
  requestContext: {
    isAI: false,
    isDocker: false,
    isGit: false,
    isGitLFS: false,
    isHF: false
  }
});

if (cachedResponse) {
  console.log('Cache hit!');
  console.log(monitor.getMetrics());  // { cache_hit: 5 }
} else {
  console.log('Cache miss, fetch from upstream');
}
```

--------------------------------

### Download arXiv Paper using Python requests

Source: https://github.com/xixu-me/xget/blob/main/README.md

Downloads an arXiv paper PDF using Python's requests library. Requires the 'requests' library to be installed. Handles HTTP status codes and writes the content to a file.

```python
# Use arXiv accelerated download in Python
import requests

def download_arxiv_paper(arxiv_id, output_path):
    url = f"https://xget.xi-xu.me/arxiv/pdf/{arxiv_id}.pdf"
    response = requests.get(url)

    if response.status_code == 200:
        with open(output_path, 'wb') as f:
            f.write(response.content)
        print(f"Downloaded {arxiv_id} to {output_path}")
    else:
        print(f"Failed to download {arxiv_id}")

# Download paper
download_arxiv_paper("2301.07041", "attention_is_all_you_need.pdf")
```

--------------------------------

### Download Common Apache Software via Xget

Source: https://github.com/xixu-me/xget/blob/main/README.zh-Hans.md

Download a selection of commonly used Apache software, including big data tools, web servers, and development tools, using direct URLs from the Xget mirror.

```bash
# Big data related
wget https://xget.xi-xu.me/apache/hive/hive-3.1.3/apache-hive-3.1.3-bin.tar.gz
wget https://xget.xi-xu.me/apache/hbase/2.5.7/hbase-2.5.7-bin.tar.gz
wget https://xget.xi-xu.me/apache/zookeeper/zookeeper-3.8.4/apache-zookeeper-3.8.4-bin.tar.gz

# Web servers
wget https://xget.xi-xu.me/apache/httpd/httpd-2.4.59.tar.gz
wget https://xget.xi-xu.me/apache/tomcat/tomcat-10/v10.1.19/bin/apache-tomcat-10.1.19.tar.gz

# Development tools
wget https://xget.xi-xu.me/apache/ant/1.10.14/apache-ant-1.10.14-bin.tar.gz
wget https://xget.xi-xu.me/apache/netbeans/netbeans/20/netbeans-20-bin.zip
```

--------------------------------

### Python OpenAI SDK with Xget Base URL

Source: https://github.com/xixu-me/xget/blob/main/docs/deploy-on-digitalocean.md

Initialize the OpenAI client in Python using an environment variable for the `base_url`, pointing to your Xget instance for API acceleration. Ensure the `OPENAI_API_KEY` is also set.

```python
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.getenv("OPENAI_API_KEY"),
    base_url=os.getenv("OPENAI_BASE_URL"),
)
```

--------------------------------

### Worker Entry Point

Source: https://context7.com/xixu-me/xget/llms.txt

The primary integration point for deploying Xget, exporting a fetch handler that delegates to handleRequest.

```javascript
// src/index.js - Main Worker export
import { handleRequest } from './app/handle-request.js';

export default {
  fetch(request, env, ctx) {
    return handleRequest(request, env, ctx);
  }
};
```
Tokens:
Raw