explaingit

7sageer/sublink-worker

4,707JavaScriptAudience · ops devopsComplexity · 3/5LicenseSetup · easy

TLDR

A tool that converts and combines proxy subscription links from multiple services into the format your preferred client app expects, deployable in one click on Cloudflare Workers or Vercel with no server to manage.

Mindmap

mindmap
  root((sublink-worker))
    What it does
      Converts proxy configs
      Combines subscriptions
      Generates short links
    Supported protocols
      ShadowSocks
      VMess and VLESS
      Hysteria2 and Trojan
    Output formats
      Sing-Box
      Clash
      Xray and V2Ray
      Surge
    Deployment options
      Cloudflare Workers
      Vercel
      Docker
      Local Node.js
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Combine multiple proxy service subscription links into one unified Clash or Sing-Box config file.

USE CASE 2

Convert a VMess or VLESS subscription to Surge format without manually editing config files.

USE CASE 3

Host your own proxy config converter on Cloudflare Workers and share converted configs via short links.

USE CASE 4

Automate proxy config updates from a script by calling the conversion API endpoint.

Tech stack

JavaScriptCloudflare WorkersNode.jsDockerRedisVercel

Getting it running

Difficulty · easy Time to first run · 5min

One-click deploy to Cloudflare Workers or Vercel, no server required for the easiest path.

Free to use and modify for personal or commercial purposes under the MIT license, as long as you include the license notice.

In plain English

Sublink Worker is a tool that converts and manages proxy subscriptions, letting people who use privacy or censorship-bypass tools combine and reformat their connection configs in one place. If you have accounts with multiple VPN-like services, each giving you a subscription link in a different format, this tool translates them all into the format your preferred client app expects. The tool supports several popular proxy protocols, including ShadowSocks, VMess, VLESS, Hysteria2, Trojan, and TUIC. On the client side, it can produce configs for Sing-Box, Clash, Xray/V2Ray, and Surge. You feed it subscription links or full config files and it handles the conversion, so you do not have to maintain separate configs for each app. Deployment is designed to be low-friction. You can run it on Cloudflare Workers with a one-click button, deploy it to Vercel, run it locally with Node.js, or spin it up in a Docker container. The Cloudflare Workers and Vercel paths are the simplest: click a button, authorize the deployment, and the service is live on a hosted URL without managing a server. For people who prefer self-hosting, the Docker option includes Redis for data storage. Once running, the tool exposes a web interface where you can paste subscription links, pick output formats, and copy or share the converted result. It can generate short links, either fixed or random, backed by key-value storage. The interface supports light and dark themes and is available in Chinese, English, Persian, and Russian. There is also an API for automating conversions from scripts. The project is open-source under the MIT license and aimed at personal use for learning and testing. The author notes that users are responsible for how they use it and asks that it not be used for illegal purposes.

Copy-paste prompts

Prompt 1
How do I deploy sublink-worker on Cloudflare Workers to convert my proxy subscription from VMess to Clash format?
Prompt 2
Show me how to use sublink-worker's API to convert a ShadowSocks subscription link to Sing-Box format using a curl command.
Prompt 3
How do I set up sublink-worker with Docker and Redis for self-hosting on my own VPS?
Prompt 4
How do I create a fixed short link for my converted proxy subscription using sublink-worker's web interface?
Open on GitHub → Explain another repo

← 7sageer on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.