base on Utility to convert between various subscription format # subconverter Utility to convert between various proxy subscription formats. [](https://github.com/tindy2013/subconverter/actions) [](https://github.com/tindy2013/subconverter/tags) [](https://github.com/tindy2013/subconverter/releases) [](https://github.com/tindy2013/subconverter/blob/master/LICENSE) [Docker README](https://github.com/tindy2013/subconverter/blob/master/README-docker.md) [中文文档](https://github.com/tindy2013/subconverter/blob/master/README-cn.md) - [subconverter](#subconverter) - [Supported Types](#supported-types) - [Quick Usage](#quick-usage) - [Access Interface](#access-interface) - [Description](#description) - [Advanced Usage](#advanced-usage) - [Auto Upload](#auto-upload) ## Supported Types | Type | As Source | As Target | Target Name | | ------------ | :--------: | :----------: | ----------- | | Clash | ✓ | ✓ | clash | | ClashR | ✓ | ✓ | clashr | | Quantumult | ✓ | ✓ | quan | | Quantumult X | ✓ | ✓ | quanx | | Loon | ✓ | ✓ | loon | | SS (SIP002) | ✓ | ✓ | ss | | SS Android | ✓ | ✓ | sssub | | SSD | ✓ | ✓ | ssd | | SSR | ✓ | ✓ | ssr | | Surfboard | ✓ | ✓ | surfboard | | Surge 2 | ✓ | ✓ | surge&ver=2 | | Surge 3 | ✓ | ✓ | surge&ver=3 | | Surge 4 | ✓ | ✓ | surge&ver=4 | | V2Ray | ✓ | ✓ | v2ray | | Telegram-liked HTTP/Socks 5 links | ✓ | × | Only as source | Notice: 1. Shadowrocket users should use `ss`, `ssr` or `v2ray` as target. 2. You can add `&remark=` to Telegram-liked HTTP/Socks 5 links to set a remark for this node. For example: - tg://http?server=1.2.3.4&port=233&user=user&pass=pass&remark=Example - https://t.me/http?server=1.2.3.4&port=233&user=user&pass=pass&remark=Example --- ## Quick Usage > Using default groups and rulesets configuration directly, without changing any settings ### Access Interface ```txt http://127.0.0.1:25500/sub?target=%TARGET%&url=%URL%&config=%CONFIG% ``` ### Description | Argument | Required | Example | Description | | -------- | :------: | :------ | ----------- | | target | Yes | clash | Target subscription type. Acquire from Target Name in [Supported Types](#supported-types). | | url | Yes | https%3A%2F%2Fwww.xxx.com | Subscription to convert. Supports URLs and file paths. Process with [URLEncode](https://www.urlencoder.org/) first. | | config | No | https%3A%2F%2Fwww.xxx.com | External configuration file path. Supports URLs and file paths. Process with [URLEncode](https://www.urlencoder.org/) first. More examples can be found in [this](https://github.com/lzdnico/subconverteriniexample) repository. | If you need to merge two or more subscription, you should join them with '|' before the URLEncode process. Example: ```txt You have 2 subscriptions and you want to merge them and generate a Clash subscription: 1. https://dler.cloud/subscribe/ABCDE?clash=vmess 2. https://rich.cloud/subscribe/ABCDE?clash=vmess First use '|' to separate 2 subscriptions: https://dler.cloud/subscribe/ABCDE?clash=vmess|https://rich.cloud/subscribe/ABCDE?clash=vmess Then process it with URLEncode to get %URL%: https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess%7Chttps%3A%2F%2Frich.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess Then fill %TARGET% and %URL% in Access Interface with actual values: http://127.0.0.1:25500/sub?target=clash&url=https%3A%2F%2Fdler.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess%7Chttps%3A%2F%2Frich.cloud%2Fsubscribe%2FABCDE%3Fclash%3Dvmess Finally subscribe this link in Clash and you are done! ``` --- ## Advanced Usage Please refer to [中文文档](https://github.com/tindy2013/subconverter/blob/master/README-cn.md#%E8%BF%9B%E9%98%B6%E7%94%A8%E6%B3%95). ## Auto Upload > Upload Gist automatically Add a [Personal Access Token](https://github.com/settings/tokens/new) into [gistconf.ini](./gistconf.ini) in the root directory, then add `&upload=true` to the local subscription link, then when you access this link, the program will automatically update the content to Gist repository. Example: ```ini [common] ;uncomment the following line and enter your token to enable upload function token = xxxxxxxxxxxxxxxxxxxxxxxx(Your Personal Access Token) ``` ", Assign "at most 3 tags" to the expected json: {"id":"3288","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"