sing-box-cli 0.0.3__tar.gz → 0.0.5__tar.gz

sing_box_cli-0.0.5/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 0.0.5 - 2025-01-07
+
+### 🚀 Features
+
+- Enable windows logs
+
+### 🐛 Bug Fixes
+
+- Show and update config encode error
+- Windows sys_platform
+- Remove init_service
+- Ignore mypy warn_unused_ignores
+- Replace schtask with raw pwsh
+
+### 📚 Documentation
+
+- Update README.md
+
+### ⚙️ Miscellaneous Tasks
+
+- Type ignore
+- Debug bin path
+
+## 0.0.3 - 2025-01-07
+
+### 🚀 Features
+
+- Sing-box service,config,logs
+
+### 🐛 Bug Fixes
+
+- Cli name
+
+<!-- generated by git-cliff -->

{sing_box_cli-0.0.3 → sing_box_cli-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sing-box-cli
-Version: 0.0.3
+Version: 0.0.5
 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
@@ -51,7 +51,15 @@ cross-platform sing-box service manager
 
 ## Install
 
-### init UV
+### uv
+
+windows
+
+```powershell
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+linux
 
 ```bash
 # root
@@ -62,14 +70,22 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
 ln -s $(which uv) /usr/local/bin/uv
 ```
 
-### add sing-box-service
+### sing-box
 
 ```bash
-sudo uv tool install sing-box-cli
+uv tool install sing-box-cli
 ```
 
 ## Run
 
+Windows in Admin powershell
+
+```powershell
+sing-box-cli --help
+```
+
+Linux
+
 ```bash
-sudo uvx sing-box --help
+sudo uv tool run sing-box-cli --help
 ```

sing_box_cli-0.0.5/README.md

@@ -0,0 +1,46 @@
+# Sing-Box CLI
+
+cross-platform sing-box service manager
+
+![](assets/image.png)
+
+## Install
+
+### uv
+
+windows
+
+```powershell
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+linux
+
+```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
+```
+
+### sing-box
+
+```bash
+uv tool install sing-box-cli
+```
+
+## Run
+
+Windows in Admin powershell
+
+```powershell
+sing-box-cli --help
+```
+
+Linux
+
+```bash
+sudo uv tool run sing-box-cli --help
+```

{sing_box_cli-0.0.3 → sing_box_cli-0.0.5}/pyproject.toml

@@ -41,7 +41,7 @@ sing-box-cli = "sing_box_service:main" # equal to from python import main; then
 
 [tool.uv]
 environments = [
-    "sys_platform == 'windows'",
+    "sys_platform == 'win32'",
     "sys_platform == 'linux'",
 ]
 
@@ -73,7 +73,7 @@ packages = ["src/sing_box_service"]
 [tool.mypy]
 strict = true
 exclude = ["venv", ".venv"]
-
+warn_unused_ignores=false
 
 ## Linter and formatter
 [tool.ruff]
@@ -209,7 +209,7 @@ sort_commits = "oldest"
 
 
 [tool.bumpversion]
-current_version = "0.0.3"
+current_version = "0.0.5"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{sing_box_cli-0.0.3 → sing_box_cli-0.0.5}/src/sing_box_service/__init__.py

@@ -2,4 +2,4 @@ from .main import main
 
 __all__ = ["main"]
 
-__version__ = "0.0.3"
+__version__ = "0.0.5"

{sing_box_cli-0.0.3 → sing_box_cli-0.0.5}/src/sing_box_service/config.py

@@ -25,6 +25,7 @@ class Config:
             raise FileNotFoundError(f"❌ {bin_filename} not found in PATH")
 
         self.bin_path = Path(bin_path)
+        print(f"🔧 Using binary: {self.bin_path}")
 
         if self.is_windows:
             self.install_dir = Path(os.environ["ProgramFiles"]) / "sing-box"
@@ -65,7 +66,7 @@ class Config:
         try:
             response = requests.get(self.sub_url)
             response.raise_for_status()
-            self.config_file.write_text(response.text)
+            self.config_file.write_text(response.text, encoding="utf-8")
             if not self.is_windows:
                 shutil.chown(self.config_file, user=self.user, group=self.user)
             print("✅ Configuration updated successfully.")
@@ -84,7 +85,7 @@ class Config:
 
     def show_config(self) -> None:
         print(f"📄 Configuration file: {self.config_file}")
-        print(self.config_file.read_text())
+        print(self.config_file.read_text(encoding="utf-8"))
 
     def show_subscription(self) -> None:
         if self.sub_url:

{sing_box_cli-0.0.3 → sing_box_cli-0.0.5}/src/sing_box_service/main.py

@@ -1,5 +1,4 @@
 import os
-import subprocess
 import sys
 
 import typer
@@ -29,7 +28,7 @@ class SingBoxCLI:
     def ensure_root(self) -> None:
         """https://gist.github.com/RDCH106/fdd419ef7dd803932b16056aab1d2300"""
         try:
-            if os.geteuid() != 0:
+            if os.geteuid() != 0:  # type: ignore
                 print("⚠️ This script must be run as root.")
                 sys.exit(1)
         except AttributeError:
@@ -46,7 +45,7 @@ def service_start() -> None:
     cli = SingBoxCLI()
     cli.ensure_root()
     cli.config.init_directories()
-    cli.service.init_service()
+    cli.service.create_service()
     cli.service.start()
     print("✅ Service started.")
     print("🔗 Dashboard URL: https://metacubexd.pages.dev/")
@@ -67,7 +66,9 @@ def service_restart() -> None:
     """Restart sing-box service"""
     cli = SingBoxCLI()
     cli.ensure_root()
-    cli.service.init_service()
+    if not cli.service.check_service():
+        cli.service.create_service()
+        print("⌛ Service created successfully.")
     cli.service.restart()
     print("✅ Service restarted.")
     print("🔗 Dashboard URL: https://metacubexd.pages.dev/")
@@ -130,10 +131,7 @@ def config_show() -> None:
 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"])
+    cli.service.logs()
 
 
 def main() -> None:

sing_box_cli-0.0.5/src/sing_box_service/service.py

@@ -0,0 +1,210 @@
+import subprocess
+from pathlib import Path
+
+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 start(self) -> None:
+        raise NotImplementedError()
+
+    def stop(self) -> None:
+        raise NotImplementedError()
+
+    def restart(self) -> None:
+        raise NotImplementedError()
+
+    def status(self) -> str:
+        raise NotImplementedError()
+
+    def logs(self) -> None:
+        raise NotImplementedError()
+
+    def disable(self) -> None:
+        raise NotImplementedError()
+
+
+class WindowsServiceManager(ServiceManager):
+    def __init__(self, config: Config):
+        super().__init__(config)
+        self.task_name = "sing-box"
+        self.log_file = self.config.install_dir / "sing-box.log"
+
+    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)
+
+[Console]::OutputEncoding = [System.Text.Encoding]::UTF8
+$OutputEncoding = [System.Text.Encoding]::UTF8
+chcp 65001 | Out-Null
+
+Set-Location "{self.config.install_dir}"
+
+if (Test-Path "{self.log_file}") {{
+    Clear-Content "{self.log_file}"
+}}
+
+try {{
+    & "{self.config.bin_path}" tools synctime -w -C "{self.config.install_dir}" *>&1 | Tee-Object -FilePath "{self.log_file}" -Append
+    & "{self.config.bin_path}" run -C "{self.config.install_dir}" *>&1 | Tee-Object -FilePath "{self.log_file}" -Append
+}} catch {{
+    $_ | Out-File -FilePath "{self.log_file}" -Append
+}}
+"""
+        start_script.write_text(script_content, encoding="utf-8")
+
+        ps_command = f"""
+$action = New-ScheduledTaskAction `
+    -Execute "pwsh.exe" `
+    -Argument "-ExecutionPolicy Bypass -NoLogo -WindowStyle Hidden -File `"{start_script}`""
+
+$trigger = New-ScheduledTaskTrigger -AtLogon
+$principal = New-ScheduledTaskPrincipal -UserId "{self.config.user}" -RunLevel Highest
+$settings = New-ScheduledTaskSettingsSet -AllowStartIfOnBatteries -DontStopIfGoingOnBatteries -StartWhenAvailable
+
+Register-ScheduledTask -TaskName "{self.task_name}" `
+    -Action $action `
+    -Trigger $trigger `
+    -Principal $principal `
+    -Settings $settings `
+    -Force
+"""
+        subprocess.run(["pwsh", "-Command", ps_command], check=True)
+
+    def check_service(self) -> bool:
+        ps_command = f"Get-ScheduledTask -TaskName '{self.task_name}' -ErrorAction SilentlyContinue"
+        result = subprocess.run(["pwsh", "-Command", ps_command], capture_output=True)
+        return result.returncode == 0
+
+    def start(self) -> None:
+        subprocess.run(
+            ["pwsh", "-Command", f"Start-ScheduledTask -TaskName '{self.task_name}'"]
+        )
+
+    def stop(self) -> None:
+        subprocess.run(
+            ["pwsh", "-Command", f"Stop-ScheduledTask -TaskName '{self.task_name}'"]
+        )
+        ps_command = "Get-Process | Where-Object { $_.ProcessName -eq 'sing-box' } | Stop-Process -Force"
+        subprocess.run(["pwsh", "-Command", ps_command])
+
+    def restart(self) -> None:
+        self.stop()
+        self.start()
+
+    def status(self) -> str:
+        ps_command = f"""
+$task = Get-ScheduledTask -TaskName '{self.task_name}' -ErrorAction SilentlyContinue
+if ($task) {{
+    $process = Get-Process | Where-Object {{ $_.Path -eq '{self.config.bin_path}' }}
+    if ($process) {{
+        "Running (PID: $($process.Id))"
+    }} else {{
+        "Stopped"
+    }}
+}} else {{
+    "Not installed"
+}}
+"""
+        result = subprocess.run(
+            ["pwsh", "-Command", ps_command], capture_output=True, text=True
+        )
+        return result.stdout.strip()
+
+    def logs(self) -> None:
+        if not self.log_file.exists():
+            print("⚠️ Log file not found")
+            return
+        try:
+            print("⌛ Showing real-time logs (Press Ctrl+C to exit)")
+            ps_command = (
+                f"Get-Content -Path '{self.log_file}' -Wait -Tail 50 -Encoding UTF8"
+            )
+            subprocess.run(["pwsh", "-Command", ps_command])
+        except KeyboardInterrupt:
+            return
+
+    def disable(self) -> None:
+        self.stop()
+        subprocess.run(
+            [
+                "pwsh",
+                "-Command",
+                f"Unregister-ScheduledTask -TaskName '{self.task_name}' -Confirm:$false",
+            ]
+        )
+
+
+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 logs(self) -> None:
+        subprocess.run(["journalctl", "-u", "sing-box", "-o", "cat", "-f"])
+
+    def disable(self) -> None:
+        self.stop()
+        subprocess.run(["systemctl", "disable", self.service_name])