{"id":19702998,"url":"https://github.com/muink/shellbox","last_synced_at":"2025-04-29T14:30:37.419Z","repository":{"id":217596294,"uuid":"738824132","full_name":"muink/shellbox","owner":"muink","description":"A lightweight sing-box subconverter/client base on shell/bash","archived":true,"fork":false,"pushed_at":"2024-08-24T13:14:38.000Z","size":337,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-15T04:27:22.681Z","etag":null,"topics":["linux","macos","shell","sing-box","windows"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/muink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-04T06:06:18.000Z","updated_at":"2025-01-03T21:55:11.000Z","dependencies_parsed_at":"2024-02-03T10:25:43.103Z","dependency_job_id":"75942761-ae45-4af7-91d0-8831ffd7cd12","html_url":"https://github.com/muink/shellbox","commit_stats":{"total_commits":7,"total_committers":2,"mean_commits":3.5,"dds":0.1428571428571429,"last_synced_commit":"ef6e1766d88c72b2b9f95a6e28b1751074b1aaca"},"previous_names":["muink/shellbox"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muink%2Fshellbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muink%2Fshellbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muink%2Fshellbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muink%2Fshellbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/muink","download_url":"https://codeload.github.com/muink/shellbox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251518738,"owners_count":21602204,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linux","macos","shell","sing-box","windows"],"created_at":"2024-11-11T21:16:43.738Z","updated_at":"2025-04-29T14:30:36.797Z","avatar_url":"https://github.com/muink.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n\u003cpre\u003e\n ___ _        _ _ ___        　\n/ __| |_  ___| | | _ ) _____ __\n\\__ \\ ' \\/ -_) | | _ \\/ _ \\ \\ /\n|___/_||_\\___|_|_|___/\\___/_\\_\\\n\u003c/pre\u003e\n\u003c/h1\u003e\n\n![Linux](https://img.shields.io/badge/Linux-FCC624?style=flat-square\u0026logo=linux\u0026logoColor=black)\n![Windows](https://img.shields.io/badge/Windows-0078D6?style=flat-square\u0026logo=windows\u0026logoColor=white)\n![macOS](https://img.shields.io/badge/mac%20os-000000?style=flat-square\u0026logo=macos\u0026logoColor=F0F0F0)\u003cbr/\u003e\n[![Releases](https://img.shields.io/github/release/muink/shellbox.svg?style=flat-square\u0026label=shellbox\u0026colorB=green)](https://github.com/muink/shellbox/releases)\n[![Releases](https://img.shields.io/badge/Documentation-8A2BE2?style=flat-square)](./docs/README.md)\n[![Releases](https://img.shields.io/github/license/muink/shellbox?style=flat-square\u0026colorB=blue)](./LICENSE)\n\nThis project is a simple [sing-box][] client running on Linux, Windows and MacOS.\n\n## Features\n\n+ Use management script to use sing-box in a shell environment\n+ Automatically import subscriptions nodes (v2ray format only)\n+ Generate complete sing-box config file from templates\n+ Online upgrade\n+ Install service or auto-start\n+ Create Shortcut\n\n## Manual\n\n### First running\n\n**NOTE:** May not work properly when path contains spaces and special characters\n\n1. Initialize environment\n   + 🐧`Linux`: Run `./tool.sh`, and follow the prompts to install missing dependencies.\n   + 🍎`MacOS`: Install [Homebrew][], then run `./tool.sh`, and follow the prompts to install missing dependencies.\n   + 🪟`Windows`: Install [Cygwin][] or [MinGW64][] or [Git4windows][], then run `./tool.sh`, and follow the prompts to install missing dependencies.\n2. Download core\n   + Run `./tool.sh`, type **5** to Upgrade core.\n3. Installation dashboard (Optional)\n   + Put dashboard assets into `./resources/ui/`.\n\n### How to configure it\n\nSee [Readme](./docs/README.md).\n\n### Generate config and setup sing-box\n\n1. Exec `./tool.sh -ug --setup`\n2. User mode\n   + 🐧`Linux`: Run `./shellbox.desktop`.\n   + 🍎`MacOS`: Run `./shellbox.command`.\n   + 🪟`Windows`: Run `./shellbox.bat`.\n3. Service mode control\n\n### How to safely uninstall service or auto-start\n\n1. Automatically\n   + Disable `service_mode`, `start_at_boot` in `settings.json`\n   + Run `./tool.sh --setup`\n2. Manually\n   + Service\n      + 🐧`Linux`:\n         + systemd: Run `sudo systemctl stop shellbox; sudo systemctl disable shellbox; sudo rm -f /etc/systemd/system/shellbox.service`\n      + 🍎`MacOS`: Run `cd /Library/LaunchDaemons; sudo launchctl unload shellbox.service.plist; sudo rm -f shellbox.service.plist`.\n      + 🪟`Windows`: Open Windows schedule, remove `ShellBox` task.\n   + Auto-start\n      + 🐧`Linux`: Remove the line containing `shellbox_core` from `/etc/crontab`.\n      + 🍎`MacOS`: Remove `shellbox.command` from [Login items][].\n      + 🪟`Windows`: Enter `%APPDATA%\\Microsoft\\Windows\\Start Menu\\Programs\\Startup` directory, remove `shellbox.bat`.\n\n## Usage\n\n**Command line mode:**\n\n``` shell\nUsage: tool.sh [OPTION]...\n\n  e.g. tool.sh -g          -- Rebuild configs\n  e.g. tool.sh -V          -- Returns version\n\nOptions:\n  -e                       -- Redirect error message to log file\n  -g, --generate           -- Rebuild configs\n  -u, --update             -- Update subscriptions\n  --setup                  -- Setup sing-box\n  -V, --version            -- Returns version\n  -h, --help               -- Returns help info\n```\n\n**Interactive mode:**\n\n``` shell\n                     [Menu]\n\n        1. Rebuild configs\n        2. Update subscriptions\n        3. Check update\n        4. Upgrade shellbox\n        5. Upgrade core\n      ------------------------------\n        a. Setup sing-box with current config\n        b. Start service\n        c. Stop service\n        x. Exit\n```\n\n[sing-box]: https://github.com/SagerNet/sing-box\n[Homebrew]: https://brew.sh/\n[Cygwin]: https://www.cygwin.com/\n[MinGW64]: https://www.mingw-w64.org/\n[Git4windows]: https://git-scm.com/\n[Login items]: https://support.apple.com/guide/mac-help/remove-login-items-resolve-startup-problems-mh21210/mac\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuink%2Fshellbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuink%2Fshellbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuink%2Fshellbox/lists"}