sing-box-cli 0.0.3__py3-none-any.whl

sing_box_cli-0.0.3.dist-info/METADATA

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: sing-box-cli
+Version: 0.0.3
+Summary: cross-platform sing-box-service manager.
+Project-URL: Homepage, https://github.com/aittcuszz/sing-box-service
+Project-URL: Issues, https://github.com/atticuszz/sing-box-service/issues
+Project-URL: documentation, https://atticuszz.github.io/sing-box-service/
+Project-URL: Changelog, https://github.com/atticuszz/sing-box-service/blob/main/CHANGELOG.md
+Author-email: "A.J.Zeller" <zhouge1831@gmail.com>
+Maintainer-email: "A.J.Zeller" <zhouge1831@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 A.J.Zeller
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: psutil>=6.1.1
+Requires-Dist: requests>=2.32.3
+Requires-Dist: typer>=0.15.1
+Description-Content-Type: text/markdown
+
+# Sing-Box CLI
+
+cross-platform sing-box service manager
+
+![](assets/image.png)
+
+## Install
+
+### init UV
+
+```bash
+# root
+sudo su
+# install as root
+curl -LsSf https://astral.sh/uv/install.sh | sh
+# create link
+ln -s $(which uv) /usr/local/bin/uv
+```
+
+### add sing-box-service
+
+```bash
+sudo uv tool install sing-box-cli
+```
+
+## Run
+
+```bash
+sudo uvx sing-box --help
+```

sing_box_cli-0.0.3.dist-info/RECORD

@@ -0,0 +1,10 @@
+sing_box_service/__init__.py,sha256=eYKke1kgc4teyR5wOBo7lsh1KjHpliVV1XpEbnK9nYE,66
+sing_box_service/config.py,sha256=oTEzYRHQvRC3kPvxtaaVm-QgEzJUnPcaoBWJyTQqve8,3340
+sing_box_service/main.py,sha256=c0KBPnd4dYVkyolZ9rUivOCwIRMQzM1lct3wST4R9C8,3636
+sing_box_service/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sing_box_service/service.py,sha256=SXB6lz0oNMgVkRNXWeo-zqRoxAefqLbcX-ZuspR5DvQ,5236
+sing_box_cli-0.0.3.dist-info/METADATA,sha256=Gfu9arQeZ9LUg5msbKsbGNJBKOqIU1l7QGxIhspUUJA,2654
+sing_box_cli-0.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sing_box_cli-0.0.3.dist-info/entry_points.txt,sha256=30dsIhKb2r4vXsdW9j6F4qyDZF0YL-5wV74iKYyYhv0,55
+sing_box_cli-0.0.3.dist-info/licenses/LICENSE,sha256=QeGTPA1ps6IxVztxQ62u7-x-oEe1S_fvleYlm5VlBc8,1067
+sing_box_cli-0.0.3.dist-info/RECORD,,

sing_box_cli-0.0.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

sing_box_cli-0.0.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sing-box-cli = sing_box_service:main

sing_box_cli-0.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 A.J.Zeller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sing_box_service/__init__.py

@@ -0,0 +1,5 @@
+from .main import main
+
+__all__ = ["main"]
+
+__version__ = "0.0.3"

sing_box_service/config.py

@@ -0,0 +1,94 @@
+import os
+import platform
+import shutil
+from pathlib import Path
+
+import requests
+from rich import print
+
+
+class Config:
+    def __init__(self) -> None:
+        self.is_windows = platform.system() == "Windows"
+        user = (
+            os.environ.get("SUDO_USER")
+            or os.environ.get("USER")
+            or os.environ.get("USERNAME")
+        )
+        if not user:
+            raise ValueError("❌ Unable to detect user name")
+
+        self.user = user
+        bin_filename = "sing-box.exe" if self.is_windows else "sing-box"
+        bin_path = shutil.which(bin_filename)
+        if not bin_path:
+            raise FileNotFoundError(f"❌ {bin_filename} not found in PATH")
+
+        self.bin_path = Path(bin_path)
+
+        if self.is_windows:
+            self.install_dir = Path(os.environ["ProgramFiles"]) / "sing-box"
+        else:
+            self.user_home = Path(os.path.expanduser(f"~{self.user}"))
+            self.install_dir = self.user_home / "proxy/sing-box"
+
+        self.config_file = self.install_dir / "config.json"
+        self.subscription_file = self.install_dir / "subscription.txt"
+
+    def init_directories(self) -> None:
+        self.install_dir.mkdir(parents=True, exist_ok=True)
+        if not self.config_file.exists():
+            self.config_file.write_text("{}")
+            print(f"📁 Created empty config file: {self.config_file}")
+
+        if not self.subscription_file.exists():
+            self.subscription_file.touch()
+            print(f"📁 Created subscription file: {self.subscription_file}")
+
+        if not self.is_windows:
+            shutil.chown(self.install_dir, user=self.user, group=self.user)
+            shutil.chown(self.config_file, user=self.user, group=self.user)
+            shutil.chown(self.subscription_file, user=self.user, group=self.user)
+
+    @property
+    def sub_url(self) -> str:
+        if not self.subscription_file.exists():
+            return ""
+        return self.subscription_file.read_text().strip()
+
+    def update_config(self) -> bool:
+        if not self.sub_url:
+            print("❌ No valid subscription URL found.")
+            return False
+
+        print(f"⌛ Updating configuration from {self.sub_url}")
+        try:
+            response = requests.get(self.sub_url)
+            response.raise_for_status()
+            self.config_file.write_text(response.text)
+            if not self.is_windows:
+                shutil.chown(self.config_file, user=self.user, group=self.user)
+            print("✅ Configuration updated successfully.")
+            return True
+        except Exception as e:
+            print(f"❌ Failed to update configuration: {e}")
+            return False
+
+    def add_subscription(self, url: str) -> bool:
+        if not url.startswith(("http://", "https://")):
+            print("❌ Invalid URL format.")
+            return False
+        self.subscription_file.write_text(url)
+        print("📁 Subscription added successfully.")
+        return True
+
+    def show_config(self) -> None:
+        print(f"📄 Configuration file: {self.config_file}")
+        print(self.config_file.read_text())
+
+    def show_subscription(self) -> None:
+        if self.sub_url:
+            print("🔗 Current subscription URL:")
+            print(self.sub_url)
+        else:
+            print("❌ No subscription URL found.")

sing_box_service/main.py

@@ -0,0 +1,144 @@
+import os
+import subprocess
+import sys
+
+import typer
+from rich import print
+
+from .config import Config
+from .service import LinuxServiceManager, WindowsServiceManager
+
+app = typer.Typer(help="sing-box service manager.")
+service = typer.Typer(help="Service management commands")
+config = typer.Typer(help="Configuration management commands")
+
+
+app.add_typer(service, name="service")
+app.add_typer(config, name="config")
+
+
+class SingBoxCLI:
+    def __init__(self) -> None:
+        self.config = Config()
+        self.service = (
+            WindowsServiceManager(self.config)
+            if self.config.is_windows
+            else LinuxServiceManager(self.config)
+        )
+
+    def ensure_root(self) -> None:
+        """https://gist.github.com/RDCH106/fdd419ef7dd803932b16056aab1d2300"""
+        try:
+            if os.geteuid() != 0:
+                print("⚠️ This script must be run as root.")
+                sys.exit(1)
+        except AttributeError:
+            import ctypes
+
+            if not ctypes.windll.shell32.IsUserAnAdmin():  # type: ignore
+                print("⚠️ This script must be run as Administrator.")
+                sys.exit(1)
+
+
+@service.command("start")
+def service_start() -> None:
+    """Start sing-box service"""
+    cli = SingBoxCLI()
+    cli.ensure_root()
+    cli.config.init_directories()
+    cli.service.init_service()
+    cli.service.start()
+    print("✅ Service started.")
+    print("🔗 Dashboard URL: https://metacubexd.pages.dev/")
+    print("🔌 Default API: http://127.0.0.1:9090")
+
+
+@service.command("stop")
+def service_stop() -> None:
+    """Stop sing-box service"""
+    cli = SingBoxCLI()
+    cli.ensure_root()
+    cli.service.stop()
+    print("✋ Service stopped.")
+
+
+@service.command("restart")
+def service_restart() -> None:
+    """Restart sing-box service"""
+    cli = SingBoxCLI()
+    cli.ensure_root()
+    cli.service.init_service()
+    cli.service.restart()
+    print("✅ Service restarted.")
+    print("🔗 Dashboard URL: https://metacubexd.pages.dev/")
+    print("🔌 Default API: http://127.0.0.1:9090")
+
+
+@service.command("status")
+def service_status() -> None:
+    """Check service status"""
+    cli = SingBoxCLI()
+    cli.ensure_root()
+    status = cli.service.status()
+    print(f"🏃 Service status: {status}")
+
+
+@service.command("disable")
+def service_disable() -> None:
+    """Disable sing-box service autostart"""
+    cli = SingBoxCLI()
+    cli.ensure_root()
+    cli.service.stop()
+    cli.service.disable()
+    print("✋ Autostart disabled.")
+
+
+@config.command("add-sub")
+def config_add_sub(url: str) -> None:
+    """Add subscription URL"""
+    cli = SingBoxCLI()
+    cli.ensure_root()
+    if cli.config.add_subscription(url):
+        if cli.config.update_config():
+            cli.service.restart()
+
+
+@config.command("update")
+def config_update() -> None:
+    """Update configuration from subscription URL"""
+    cli = SingBoxCLI()
+    cli.ensure_root()
+    if cli.config.update_config():
+        cli.service.restart()
+
+
+@config.command("show-sub")
+def config_show_sub() -> None:
+    """Show subscription URL"""
+    cli = SingBoxCLI()
+    cli.config.show_subscription()
+
+
+@config.command("show")
+def config_show() -> None:
+    """Show configuration"""
+    cli = SingBoxCLI()
+    cli.config.show_config()
+
+
+@app.command()
+def logs() -> None:
+    """Show sing-box service logs"""
+    cli = SingBoxCLI()
+    if cli.config.is_windows:
+        print("⚠️ Log viewing is not supported on Windows")
+    else:
+        subprocess.run(["journalctl", "-u", "sing-box", "-o", "cat", "-f"])
+
+
+def main() -> None:
+    app()
+
+
+if __name__ == "__main__":
+    main()

sing_box_service/service.py

@@ -0,0 +1,172 @@
+import subprocess
+from pathlib import Path
+
+import psutil
+from rich import print
+
+from .config import Config
+
+
+class ServiceManager:
+    def __init__(self, config: Config):
+        self.config = config
+
+    def create_service(self) -> None:
+        raise NotImplementedError()
+
+    def check_service(self) -> bool:
+        raise NotImplementedError()
+
+    def init_service(self) -> None:
+        if not self.check_service():
+            print("⌛ Creating service...")
+            self.create_service()
+
+    def start(self) -> None:
+        raise NotImplementedError()
+
+    def stop(self) -> None:
+        raise NotImplementedError()
+
+    def restart(self) -> None:
+        raise NotImplementedError()
+
+    def status(self) -> str:
+        raise NotImplementedError()
+
+    def disable(self) -> None:
+        raise NotImplementedError()
+
+
+class WindowsServiceManager(ServiceManager):
+    def __init__(self, config: Config):
+        super().__init__(config)
+        self.task_name = "sing-box"
+
+    def create_service(self) -> None:
+        start_script = self.config.install_dir / "start-singbox.ps1"
+        script_content = f"""
+        Add-Type -Name Window -Namespace Console -MemberDefinition '
+        [DllImport("Kernel32.dll")]
+        public static extern IntPtr GetConsoleWindow();
+        [DllImport("user32.dll")]
+        public static extern bool ShowWindow(IntPtr hWnd, Int32 nCmdShow);
+        '
+        $console = [Console.Window]::GetConsoleWindow()
+        [Console.Window]::ShowWindow($console, 0)
+
+        Set-Location "{self.config.install_dir}"
+        & "{self.config.bin_path}" tools synctime -w -C "{self.config.install_dir}"
+        & "{self.config.bin_path}" run -C "{self.config.install_dir}"
+        """
+        start_script.write_text(script_content)
+
+        subprocess.run(
+            [
+                "schtasks",
+                "/create",
+                "/tn",
+                self.task_name,
+                "/tr",
+                f"powershell -ExecutionPolicy Bypass -File {start_script}",
+                "/sc",
+                "onlogon",
+                "/ru",
+                self.config.user,
+                "/rl",
+                "HIGHEST",
+                "/f",
+            ]
+        )
+
+    def check_service(self) -> bool:
+        try:
+            subprocess.run(
+                ["schtasks", "/query", "/tn", self.task_name],
+                capture_output=True,
+                check=True,
+            )
+            return True
+        except subprocess.CalledProcessError:
+            return False
+
+    def start(self) -> None:
+        subprocess.run(["schtasks", "/run", "/tn", self.task_name])
+
+    def stop(self) -> None:
+        subprocess.run(["schtasks", "/end", "/tn", self.task_name])
+        for proc in psutil.process_iter(["name"]):
+            if proc.info["name"] == "sing-box.exe":
+                proc.kill()
+
+    def restart(self) -> None:
+        self.stop()
+        self.start()
+
+    def status(self) -> str:
+        try:
+            output = subprocess.check_output(
+                ["schtasks", "/query", "/tn", self.task_name]
+            )
+            return "Running" if "Running" in output.decode() else "Stopped"
+        except Exception:
+            return "Not installed"
+
+    def disable(self) -> None:
+        self.stop()
+        subprocess.run(["schtasks", "/delete", "/tn", self.task_name, "/f"])
+
+
+class LinuxServiceManager(ServiceManager):
+    def __init__(self, config: Config):
+        super().__init__(config)
+        self.service_name = "sing-box"
+        self.service_file = Path("/etc/systemd/system/sing-box.service")
+
+    def create_service(self) -> None:
+        service_content = f"""
+[Unit]
+Description=sing-box service
+Documentation=https://sing-box.sagernet.org
+After=network.target nss-lookup.target
+
+[Service]
+Type=simple
+LimitNPROC=500
+LimitNOFILE=1000000
+CapabilityBoundingSet=CAP_NET_ADMIN CAP_NET_RAW CAP_NET_BIND_SERVICE CAP_SYS_TIME CAP_SYS_PTRACE CAP_DAC_READ_SEARCH CAP_DAC_OVERRIDE
+AmbientCapabilities=CAP_NET_ADMIN CAP_NET_RAW CAP_NET_BIND_SERVICE CAP_SYS_TIME CAP_SYS_PTRACE CAP_DAC_READ_SEARCH CAP_DAC_OVERRIDE
+Restart=always
+ExecStartPre={self.config.bin_path} tools synctime -w -C {self.config.install_dir}
+ExecStart={self.config.bin_path} run -C {self.config.install_dir}
+ExecReload=/bin/kill -HUP $MAINPID
+
+[Install]
+WantedBy=multi-user.target
+"""
+        self.service_file.write_text(service_content)
+        subprocess.run(["systemctl", "daemon-reload"])
+        subprocess.run(["systemctl", "enable", self.service_name])
+
+    def check_service(self) -> bool:
+        return self.service_file.exists()
+
+    def start(self) -> None:
+        subprocess.run(["systemctl", "start", self.service_name])
+
+    def stop(self) -> None:
+        subprocess.run(["systemctl", "stop", self.service_name])
+
+    def restart(self) -> None:
+        subprocess.run(["systemctl", "restart", self.service_name])
+
+    def status(self) -> str:
+        try:
+            subprocess.check_call(["systemctl", "is-active", self.service_name])
+            return "Running"
+        except Exception:
+            return "Stopped"
+
+    def disable(self) -> None:
+        self.stop()
+        subprocess.run(["systemctl", "disable", self.service_name])