\n \nunbox

\n
\n\nUnbox is a CLI tool for [sing-box](https://github.com/SagerNet/sing-box) that has commands: \n1. `examples`: Show usage examples\n2. `conf`: Works with sing-box config file to\n - [Deduplicate](https://github.com/aceberg/unbox#deduplicate) (compares all fields but `tag`)\n - [Convert sing-box config outbounds to URLs](https://github.com/aceberg/unbox#convert-sing-box-config-outbounds-to-urls)\n - [Remove unreachable nodes from sing-box config file](https://github.com/aceberg/unbox#remove-unreachable-nodes-from-sing-box-config)\n3. `keep`: [Keep connection alive, auto switch proxy](https://github.com/aceberg/unbox#keep-connection-alive-and-switch-if-not)\n4. `parse`: [Convert file with URLs to sing-box config](https://github.com/aceberg/unbox#convert-file-with-urls-to-sing-box-config)\n\nSupported URLs: `vless://`,`hysteria2://` or `hy2://`,`trojan://` \nExperimental: `anytls://`, `ss://`, `tuic://`\n\n\n\n## Screenshot\n\n

Expand

\n\n![Screenshot_1](https://raw.githubusercontent.com/aceberg/unbox/main/assets/Screenshot_1.png) \n

\n\n## Install\n

Expand

\n\n### Docker\nExample `keep` command with sing-box Clash API:\n```sh\ndocker run aceberg/unbox keep -a \"http://192.168.0.11:9090\"\n```\nOr use `ghcr.io/aceberg/unbox`\n\n### Binary\nAll available binaries are listed in the [latest](https://github.com/aceberg/unbox/releases/latest) release. \nFor `amd64` there is an `apt` [repo](https://github.com/aceberg/ppa).\n\n### Android and Termux\nFor `arm64` there are `android` and `termux.deb` [files](https://github.com/aceberg/unbox/releases/latest).\n

\n\n## Deduplicate\n

Expand

\n\n```sh\nunbox conf -d -o sing-box.json\n```\n\n| Key | Description | Default |\n| --- | ----------- | ------- |\n| -d | Deduplicate | |\n| -o | Path to sing-box config file | |\n\n

\n\n## Convert sing-box config outbounds to URLs\n

Expand

\n\n```sh\nunbox conf -i sing-box.json > URLs.txt\n```\n\n| Key | Description | Default |\n| --- | ----------- | ------- |\n| -i | Path to sing-box config file | |\n\n

\n\n## Remove unreachable nodes from sing-box config\n

Expand

\n\n```sh\nunbox conf -a \"http://127.0.0.1:9090\" -o sing-box.json\n```\n\n| Key | Description | Default |\n| --- | ----------- | ------- |\n| -a | URL of sing-box Clash API | |\n| -as | Clash API secret | |\n| -l | Timeout for proxy delay (latency) check (ms) | 3000 |\n| -n | Number of best servers to save (0 - save all) | 0 |\n| -o | Path to sing-box config file | |\n| -u | URL to test proxies. `https://www.gstatic.com/generate_204` will be used if empty | |\n\n

\n\n## Keep connection alive and switch if not\n

Expand

\n\n```sh\nunbox keep -a \"http://127.0.0.1:9090\"\n```\n\n| Key | Description | Default |\n| --- | ----------- | ------- |\n| -a | URL of sing-box Clash API | |\n| -as | Clash API secret | |\n| -da | Delay between checks of all proxy servers (seconds). Use 0 to disable | 300 |\n| -db | Delay between checks of 4-5 backup servers (seconds). Use 0 to disable | 30 |\n| -dm | Delay between checks of the main server (seconds). Use 0 to disable | 5 |\n| -ds | Delay between auto switch to a faster proxy attempts (seconds). Use 0 to disable | 300 |\n| -l | Timeout for proxy delay (latency) check (ms) | 3000 |\n| -n | Number of backup servers | 5 |\n| -st | Switch to a faster proxy if it is at least this many ms faster than the current one (ms) | 50 |\n| -u | URL to test proxies. `https://www.gstatic.com/generate_204` will be used if empty | |\n\n\n

\n\n## Convert file with URLs to sing-box config\n

Expand

\n\nHere `VLESS.txt` is a file with `vless://`,`hysteria2://`,`trojan://` links. Unbox will ignore anything else in the file, including other protocols and comments.\n```sh\nunbox parse -f VLESS.txt\n```\nIn this example `tmpl.json` is a [template](https://github.com/aceberg/unbox/blob/main/configs/sing-box.tmpl.json) sing-box config and `sing-box.json` is where unbox will put generated config.\n```sh\nunbox parse -f VLESS.txt -t tmpl.json -o sing-box.json -j\n```\n\n| Key | Description | Default |\n| --- | ----------- | ------- |\n| -f | Path to file with URLs | VLESS.txt |\n| -j | Validate and Indent JSON output | |\n| -n | Rename tags. If used, will rename tags to `tag1`, `tag2`... | |\n| -o | Path to output sing-box config file | |\n| -t | Path to template sing-box config. Example [here](https://github.com/aceberg/unbox/blob/main/configs/sing-box.tmpl.json). There are only two variables available in template: `{{ .Unbox_tags }}` and `{{ .Unbox_outbounds }}` | |\n

\n\n## Thanks\n\n- [SagerNet/sing-box](https://github.com/SagerNet/sing-box)\n- Unboxing icons created by Futuer - Flaticon","has_starred","hub_user","immutable_tags_settings",{"_203":11,"_204":205},"enabled","rules",[206],".*","is_automated","permissions",{"_210":17,"_211":11,"_212":11},"read","write","admin","user","storage_size",282568184,"isOrg","reponame","tag","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_23":24,"_161":-7,"_159":-7,"_160":-7,"_25":227,"_31":42,"_237":238,"_244":11},{"_27":28,"_29":30,"_31":32,"_33":34,"_35":36,"_37":228,"_95":96,"_97":30,"_98":99,"_100":101,"_102":103,"_104":105,"_106":79,"_107":96,"_108":55,"_109":17},[229,230,231,232,233,234,235,236],{"_40":41,"_31":42,"_43":44,"_45":46,"_47":48,"_49":50,"_51":44,"_52":-5,"_53":34,"_54":55,"_56":-5},{"_40":58,"_31":59,"_43":44,"_45":60,"_47":61,"_49":50,"_51":44,"_52":-5,"_53":62,"_54":55,"_56":-5},{"_40":64,"_31":65,"_43":44,"_45":66,"_47":67,"_49":50,"_51":44,"_52":-5,"_53":68,"_54":55,"_56":69},{"_40":64,"_31":71,"_43":44,"_45":72,"_47":73,"_49":50,"_51":44,"_52":-5,"_53":74,"_54":55,"_56":75},{"_40":77,"_31":78,"_43":44,"_45":79,"_47":80,"_49":77,"_51":44,"_52":-5,"_53":81,"_54":55,"_56":-5},{"_40":77,"_31":83,"_43":44,"_45":84,"_47":85,"_49":77,"_51":44,"_52":-5,"_53":81,"_54":55,"_56":-5},{"_40":77,"_31":87,"_43":44,"_45":88,"_47":89,"_49":77,"_51":44,"_52":-5,"_53":90,"_54":55,"_56":-5},{"_40":77,"_31":92,"_43":44,"_45":93,"_47":94,"_49":77,"_51":44,"_52":-5,"_53":90,"_54":55,"_56":-5},"imageWithLayers",{"_40":41,"_31":42,"_43":44,"_45":46,"_47":48,"_113":239,"_49":50,"_51":44,"_52":-5,"_53":34,"_54":55,"_56":-5},[240,241,242,243],{"_31":116,"_53":117,"_118":119},{"_31":121,"_53":122,"_118":123},{"_31":125,"_53":126,"_118":127},{"_53":129,"_118":130,"_31":44},"hasPermissionToViewRepoSettings","actionData","errors"]

aceberg/unbox:0.1.3