\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",{"_202":11,"_203":204},"enabled","rules",[205],".*","is_automated","permissions",{"_209":17,"_210":11,"_211":11},"read","write","admin","user","storage_size",282568184,"isOrg","reponame","tag","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_22":23,"_160":-7,"_158":-7,"_159":-7,"_24":225,"_30":64,"_235":236,"_242":11},{"_26":27,"_28":29,"_30":31,"_32":33,"_34":35,"_36":226,"_94":95,"_96":29,"_97":98,"_99":100,"_101":102,"_103":104,"_105":78,"_106":95,"_107":54,"_108":17},[227,228,229,230,231,232,233,234],{"_39":40,"_30":41,"_42":43,"_44":45,"_46":47,"_48":49,"_50":43,"_51":-5,"_52":33,"_53":54,"_55":-5},{"_39":57,"_30":58,"_42":43,"_44":59,"_46":60,"_48":49,"_50":43,"_51":-5,"_52":61,"_53":54,"_55":-5},{"_39":63,"_30":64,"_42":43,"_44":65,"_46":66,"_48":49,"_50":43,"_51":-5,"_52":67,"_53":54,"_55":68},{"_39":63,"_30":70,"_42":43,"_44":71,"_46":72,"_48":49,"_50":43,"_51":-5,"_52":73,"_53":54,"_55":74},{"_39":76,"_30":77,"_42":43,"_44":78,"_46":79,"_48":76,"_50":43,"_51":-5,"_52":80,"_53":54,"_55":-5},{"_39":76,"_30":82,"_42":43,"_44":83,"_46":84,"_48":76,"_50":43,"_51":-5,"_52":80,"_53":54,"_55":-5},{"_39":76,"_30":86,"_42":43,"_44":87,"_46":88,"_48":76,"_50":43,"_51":-5,"_52":89,"_53":54,"_55":-5},{"_39":76,"_30":91,"_42":43,"_44":92,"_46":93,"_48":76,"_50":43,"_51":-5,"_52":89,"_53":54,"_55":-5},"imageWithLayers",{"_39":63,"_30":64,"_42":43,"_44":65,"_46":66,"_112":237,"_48":49,"_50":43,"_51":-5,"_52":67,"_53":54,"_55":68},[238,239,240,241],{"_30":115,"_52":116,"_117":118},{"_30":120,"_52":121,"_117":122},{"_30":143,"_52":144,"_117":126},{"_52":128,"_117":129,"_30":43},"hasPermissionToViewRepoSettings","actionData","errors"]

aceberg/unbox:0.2.2