sing-box-cli 0.1.2__tar.gz → 0.1.3__tar.gz

{sing_box_cli-0.1.2 → sing_box_cli-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sing-box-cli
-Version: 0.1.2
+Version: 0.1.3
 Summary: cross-platform sing-box manager.
 Project-URL: Homepage, https://github.com/aittcuszz/sing-box-service
 Project-URL: Issues, https://github.com/atticuszz/sing-box-service/issues
@@ -80,10 +80,19 @@ uv tool install sing-box-cli
 ```bash
 # linux
 uv tool install sing-box-cli
-sudo ln -sf $(which sing-box-cli) /usr/local/bin/
-sudo ln -sf $(which sbc) /usr/local/bin/
+sbc install
 ```
 
+On Linux, `sbc install` installs both `sbc` and `sing-box-cli` into
+`/usr/local/bin`, requesting sudo only to write those system launchers. It replaces
+the old manual symlinks and can be run again safely. Use `--bin-dir PATH` to select
+another existing executable directory. Unrelated files are preserved.
+
+The system launchers use Python `-B`, so commands such as `sudo sbc service enable`
+do not create root-owned `__pycache__` files in your uv environment. Run the install
+command as your normal user after installing the tool. Do not run `uv tool install`,
+`uv tool upgrade`, or `uv run` with sudo.
+
 Install with specific sing-box version
 
 ```bash
@@ -95,6 +104,9 @@ Upgrade
 uv tool upgrade sing-box-cli
 ```
 
+Linux launchers continue to use the same environment after a normal uv upgrade.
+Run `sbc install` again if you move or change the installation environment.
+
 After upgrading on Windows, run the following in an administrator PowerShell:
 
 ```powershell
@@ -147,3 +159,28 @@ Linux
 ```bash
 sudo sbc --help
 ```
+
+## Serve private GitHub configurations
+
+Set `GH_TOKEN` (or `GITHUB_TOKEN`) with **Contents: read** access to your private
+repository, then run as your normal user:
+
+```bash
+sbc config serve add https://github.com/owner/private-configs --domain sub.example.com
+sbc config serve list
+sbc config serve start
+sbc config serve stop
+```
+
+`list` prints URLs for valid root `.json` configurations. The server reads GitHub
+through its API without cloning; `start` runs in the background at `127.0.0.1:8080`
+by default. Use `--host` and `--port` for another listening address.
+
+Point Traefik at the server using [this example](docs/traefik-config-serve.yml).
+Clients continue to use the existing update command:
+
+```bash
+sbc config update https://sub.example.com/alice.json --restart
+```
+
+See [configuration server details](docs/config-serve.md) for settings, logs and limits.

{sing_box_cli-0.1.2 → sing_box_cli-0.1.3}/README.md

@@ -31,10 +31,19 @@ uv tool install sing-box-cli
 ```bash
 # linux
 uv tool install sing-box-cli
-sudo ln -sf $(which sing-box-cli) /usr/local/bin/
-sudo ln -sf $(which sbc) /usr/local/bin/
+sbc install
 ```
 
+On Linux, `sbc install` installs both `sbc` and `sing-box-cli` into
+`/usr/local/bin`, requesting sudo only to write those system launchers. It replaces
+the old manual symlinks and can be run again safely. Use `--bin-dir PATH` to select
+another existing executable directory. Unrelated files are preserved.
+
+The system launchers use Python `-B`, so commands such as `sudo sbc service enable`
+do not create root-owned `__pycache__` files in your uv environment. Run the install
+command as your normal user after installing the tool. Do not run `uv tool install`,
+`uv tool upgrade`, or `uv run` with sudo.
+
 Install with specific sing-box version
 
 ```bash
@@ -46,6 +55,9 @@ Upgrade
 uv tool upgrade sing-box-cli
 ```
 
+Linux launchers continue to use the same environment after a normal uv upgrade.
+Run `sbc install` again if you move or change the installation environment.
+
 After upgrading on Windows, run the following in an administrator PowerShell:
 
 ```powershell
@@ -98,3 +110,28 @@ Linux
 ```bash
 sudo sbc --help
 ```
+
+## Serve private GitHub configurations
+
+Set `GH_TOKEN` (or `GITHUB_TOKEN`) with **Contents: read** access to your private
+repository, then run as your normal user:
+
+```bash
+sbc config serve add https://github.com/owner/private-configs --domain sub.example.com
+sbc config serve list
+sbc config serve start
+sbc config serve stop
+```
+
+`list` prints URLs for valid root `.json` configurations. The server reads GitHub
+through its API without cloning; `start` runs in the background at `127.0.0.1:8080`
+by default. Use `--host` and `--port` for another listening address.
+
+Point Traefik at the server using [this example](docs/traefik-config-serve.yml).
+Clients continue to use the existing update command:
+
+```bash
+sbc config update https://sub.example.com/alice.json --restart
+```
+
+See [configuration server details](docs/config-serve.md) for settings, logs and limits.

sing_box_cli-0.1.3/docs/config-serve.md

@@ -0,0 +1,49 @@
+# Configuration server
+
+The server maps one domain to one private GitHub repository. Multiple domains can
+share a server. Set `GH_TOKEN` or `GITHUB_TOKEN` to a fine-grained token with
+**Contents: read** access to all registered repositories.
+
+`config serve add` checks GitHub access and saves the binding; registering the same
+binding again is safe. `config serve list` validates root `.json` files with the
+sing-box core bundled with this package, prints valid URLs, and reports invalid
+configurations on stderr.
+
+## Background process
+
+`config serve start` waits until the socket is listening, then prints the PID,
+address and log path. Closing the terminal leaves the server running. Repeated
+starts use the existing process, and repeated stops are safe. Run `stop` as the
+same user with the same state directory. Restart after changing the GitHub token
+or upgrading the package. Boot-time startup is managed separately by deployment.
+
+Settings, process identity and `serve.log` are stored in the platform's
+`sing-box-cli/serve` application directory (`~/.config/sing-box-cli/serve` on Linux).
+Set `SBC_SERVE_DIR` to use another directory for all commands. Tokens and client
+configuration are not stored there. New registrations take effect while running.
+
+## GitHub reads and validation
+
+Requests read the repository's default branch through the GitHub Contents API.
+No Git installation, clone/pull, background synchronization or persistent config
+cache is needed. File updates and deletions take effect on subsequent requests.
+
+Each response is validated and preserves the original content. Missing files,
+invalid configurations and GitHub errors return HTTP errors. Configurations are
+limited to 5 MiB and must be compatible with the bundled core. Referenced sibling
+files are not downloaded. Existing client `--token` subscriptions and saved
+settings remain supported; server URLs need no client token.
+
+## Traefik
+
+Merge [the example router and service](traefik-config-serve.yml) into the existing
+`http.routers` and `http.services` sections. Traefik must preserve the `Host` header.
+The example uses `websecure` and the host gateway from `digitalocean-public`'s
+`~/devspace/traefik.yml`. Bind to that gateway for this deployment:
+
+```bash
+sbc config serve start --host 172.18.0.1 --port 8080
+```
+
+Replace `sub.example.com` with your domain and configure DNS and the TLS
+certificate through your deployment. `--domain` only registers the binding.

sing_box_cli-0.1.3/docs/traefik-config-serve.yml

@@ -0,0 +1,19 @@
+# Merge these entries into the existing http.routers and http.services sections.
+# Set the domain to match config serve add --domain.
+http:
+  routers:
+    config-serve:
+      rule: "Host(`sub.example.com`)"
+      entryPoints:
+        - websecure
+      service: config-serve
+      tls: {}
+
+  services:
+    config-serve:
+      loadBalancer:
+        passHostHeader: true
+        servers:
+          # Host gateway used by the existing digitalocean-public Traefik config.
+          # Bind sbc config serve start --host 172.18.0.1 --port 8080 on the host.
+          - url: "http://172.18.0.1:8080"

{sing_box_cli-0.1.2 → sing_box_cli-0.1.3}/pyproject.toml

@@ -75,7 +75,7 @@ packages = ["src/sing_box_cli"]
 path = "hatch_build.py"
 
 [tool.hatch.build.targets.sdist]
-include = ["/src", "/windows-service", "/hatch_build.py", "/pyproject.toml", "/README.md", "/LICENSE"]
+include = ["/src", "/windows-service", "/docs", "/hatch_build.py", "/pyproject.toml", "/README.md", "/LICENSE"]
 
 ## Test
 [tool.mypy]
@@ -215,7 +215,7 @@ topo_order = false
 sort_commits = "oldest"
 
 [tool.bumpversion]
-current_version        = "0.1.2"
+current_version        = "0.1.3"
 parse                  = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize              = ["{major}.{minor}.{patch}"]
 search                 = "{current_version}"

{sing_box_cli-0.1.2 → sing_box_cli-0.1.3}/src/sing_box_cli/__init__.py

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

{sing_box_cli-0.1.2 → sing_box_cli-0.1.3}/src/sing_box_cli/api/__init__.py

@@ -1,5 +1,6 @@
 import asyncio
-from typing import Annotated
+from collections.abc import Callable, Coroutine
+from typing import Annotated, Any
 
 import typer
 
@@ -53,16 +54,33 @@ def create_client(
     return SingBoxAPIClient(base_url, token)
 
 
+def _run_tui(
+    ctx: typer.Context,
+    command: Callable[[SingBoxAPIClient], Coroutine[Any, Any, None]],
+    base_url: StrOrNone,
+    token: StrOrNone,
+) -> None:
+    """Run an interactive command and handle user-requested exits consistently."""
+    try:
+        ctx_obj = get_context_obj(ctx)
+        api_client = create_client(ctx_obj.config, base_url, token)
+        asyncio.run(command(api_client))
+    except (KeyboardInterrupt, EOFError):
+        pass
+    print("Exited.")
+
+
 @api.command()
 def stats(
     ctx: typer.Context, base_url: ApiUrlOption = None, token: ApiTokenOption = None
 ) -> None:
     """Show sing-box traffic, memory statistics and connections, requires API token(Optional)"""
-    ctx_obj = get_context_obj(ctx)
-    api_client = create_client(ctx_obj.config, base_url, token)
-    visualizer = ResourceVisualizer()
-    monitor = ResourceMonitor(api_client, visualizer)
-    asyncio.run(monitor.start())
+    _run_tui(
+        ctx,
+        lambda client: ResourceMonitor(client, ResourceVisualizer()).start(),
+        base_url,
+        token,
+    )
 
 
 @api.command()
@@ -70,10 +88,7 @@ def conns(
     ctx: typer.Context, base_url: ApiUrlOption = None, token: ApiTokenOption = None
 ) -> None:
     """Manage sing-box connections, requires API token(Optional)"""
-    ctx_obj = get_context_obj(ctx)
-    api_client = create_client(ctx_obj.config, base_url, token)
-    manager = ConnectionsManager(api_client)
-    asyncio.run(manager.run())
+    _run_tui(ctx, lambda client: ConnectionsManager(client).run(), base_url, token)
 
 
 @api.command()
@@ -81,10 +96,7 @@ def proxy(
     ctx: typer.Context, base_url: ApiUrlOption = None, token: ApiTokenOption = None
 ) -> None:
     """Manage sing-box policy groups, requires API token(Optional)"""
-    ctx_obj = get_context_obj(ctx)
-    api_client = create_client(ctx_obj.config, base_url, token)
-    manager = PolicyGroupManager(api_client)
-    asyncio.run(manager.run())
+    _run_tui(ctx, lambda client: PolicyGroupManager(client).run(), base_url, token)
 
 
 @api.command()
@@ -95,7 +107,5 @@ def logs(
     token: ApiTokenOption = None,
 ) -> None:
     """Show sing-box logs, requires API token(Optional)"""
-    ctx_obj = get_context_obj(ctx)
-    api_client = create_client(ctx_obj.config, base_url, token)
     print("⌛ Showing real-time logs (Press Ctrl+C to exit)")
-    asyncio.run(get_logs(api_client, log_level))
+    _run_tui(ctx, lambda client: get_logs(client, log_level), base_url, token)

{sing_box_cli-0.1.2 → sing_box_cli-0.1.3}/src/sing_box_cli/api/client.py

@@ -5,6 +5,7 @@ Provides an async client for interacting with Sing-Box HTTP API.
 
 import json
 from collections.abc import AsyncGenerator
+from contextlib import aclosing
 from typing import Any, TypeVar
 
 import httpx
@@ -224,8 +225,11 @@ class SingBoxAPIClient:
         Yields:
             TrafficData object containing traffic data (up/down in B/s)
         """
-        async for data in self._make_stream_request("/traffic", TrafficData):
-            yield data
+        async with aclosing(
+            self._make_stream_request("/traffic", TrafficData)
+        ) as stream:
+            async for data in stream:
+                yield data
 
     async def memory_stream(self) -> AsyncGenerator[MemoryData, None]:
         """
@@ -234,8 +238,9 @@ class SingBoxAPIClient:
         Yields:
             MemoryData object containing memory data (inuse/total in bytes)
         """
-        async for data in self._make_stream_request("/memory", MemoryData):
-            yield data
+        async with aclosing(self._make_stream_request("/memory", MemoryData)) as stream:
+            async for data in stream:
+                yield data
 
     async def log_stream(
         self, level: str | None = None
@@ -247,8 +252,11 @@ class SingBoxAPIClient:
             LogEntry object containing log data (type/payload)
         """
         params = {"level": level} if level else None
-        async for data in self._make_stream_request("/logs", LogEntry, params=params):
-            yield data
+        async with aclosing(
+            self._make_stream_request("/logs", LogEntry, params=params)
+        ) as stream:
+            async for data in stream:
+                yield data
 
     async def get_connections(self) -> ConnectionData:
         """

{sing_box_cli-0.1.2 → sing_box_cli-0.1.3}/src/sing_box_cli/api/connections.py

@@ -4,6 +4,7 @@ from prompt_toolkit.application import Application
 from prompt_toolkit.buffer import Buffer
 from prompt_toolkit.formatted_text import FormattedText
 from prompt_toolkit.key_binding import KeyBindings
+from prompt_toolkit.keys import Keys
 from prompt_toolkit.layout import (
     FormattedTextControl,
     HSplit,
@@ -168,7 +169,9 @@ class ConnectionsManager:
     def setup_keybindings(self) -> None:
         """Setup keyboard shortcuts."""
 
+        @self.kb.add("c-c")
         @self.kb.add("c-q")
+        @self.kb.add(Keys.SIGINT)
         def _(event) -> None:  # type: ignore[no-untyped-def]  # noqa: ARG001
             """Quit the application."""
             event.app.exit()
@@ -176,13 +179,14 @@ class ConnectionsManager:
         @self.kb.add("c-d")
         def _(event) -> None:  # type: ignore[no-untyped-def]  # noqa: ARG001
             """Close the connection."""
-            conn_id = self.selected_connection.id
-            asyncio.create_task(self.close_connection(str(conn_id)))
+            if self.filtered_connections:
+                conn_id = self.selected_connection.id
+                event.app.create_background_task(self.close_connection(str(conn_id)))
 
-        @self.kb.add("c-c")
+        @self.kb.add("c-x", eager=True)
         def _(event) -> None:  # type: ignore[no-untyped-def]  # noqa: ARG001
-            """Close the connection."""
-            asyncio.create_task(self.close_all_connections())
+            """Close all connections."""
+            event.app.create_background_task(self.close_all_connections())
 
         @self.kb.add("down")
         def _(event) -> None:  # type: ignore[no-untyped-def]  # noqa: ARG001
@@ -301,7 +305,7 @@ class ConnectionsManager:
                 lambda: [
                     (
                         "class:status-bar",
-                        " Ctrl+Q: Quit,  Ctrl+D: Close,  Ctrl+C: Close All, "
+                        " Ctrl+C/Ctrl+Q: Quit, Ctrl+D: Close, Ctrl+X: Close All, "
                         " ↑/↓: Move,  ←/→: Page, "
                         " Home/End: First/Last Page, "
                         " Input: Search",
@@ -377,6 +381,7 @@ class ConnectionsManager:
 
     async def close_connection(self, conn_id: str) -> None:
         """Close a specific connection."""
+        cnnt_info = f"Connection {conn_id=}"
         try:
             await self.api_client.close_connection(conn_id)
             host = self.selected_connection.metadata.host
@@ -386,7 +391,6 @@ class ConnectionsManager:
             await self.refresh_connections()
         except Exception as e:
             self.status_message = f"Error closing {cnnt_info}: {str(e)}"
-            raise
 
     async def close_all_connections(self) -> None:
         """Close all connections."""
@@ -397,7 +401,6 @@ class ConnectionsManager:
             await self.refresh_connections()
         except Exception as e:
             self.status_message = f"Error closing all connections: {str(e)}"
-            raise
 
     async def refresh_connections(self) -> None:
         """Refresh the connections data."""
@@ -420,23 +423,21 @@ class ConnectionsManager:
     async def run(self) -> None:
         """Run the interactive manager."""
         self.running = True
-        # Initial load of connections
-        await self.refresh_connections()
-        self.status_message = self.get_filter_state()
-
-        # Setup periodic refresh task
-        refresh_task = asyncio.create_task(self.periodic_refresh())
-
+        refresh_task = None
         try:
+            # Initial load of connections
+            await self.refresh_connections()
+            self.status_message = self.get_filter_state()
+            refresh_task = asyncio.create_task(self.periodic_refresh())
             await self.app.run_async()
         finally:
             self.running = False
-            # Clean up periodic refresh
-            refresh_task.cancel()
-            try:
-                await refresh_task
-            except asyncio.CancelledError:
-                pass
+            if refresh_task is not None:
+                refresh_task.cancel()
+                try:
+                    await refresh_task
+                except asyncio.CancelledError:
+                    pass
 
     async def periodic_refresh(self, interval: float = 0.5) -> None:
         """Periodically refresh connections."""

sing_box_cli-0.1.3/src/sing_box_cli/api/logs.py

@@ -0,0 +1,93 @@
+import re
+from contextlib import aclosing
+from datetime import datetime
+
+from rich import print
+from rich.text import Text
+
+from ..common import LogLevel
+from .client import SingBoxAPIClient
+
+
+async def get_logs(client: SingBoxAPIClient, log_level: LogLevel) -> None:
+    # Define color mapping for log levels with brighter colors
+    # Ref: https://rich.readthedocs.io/en/stable/appendix/colors.html
+    log_level_colors = {
+        "trace": "bright_black",
+        "debug": "grey66",
+        "info": "bright_cyan",
+        "warning": "bright_yellow",
+        "error": "bright_red",
+        "fatal": "bright_magenta",
+        "panic": "bright_magenta",
+    }
+
+    # Bright colors for IDs
+    id_colors = [
+        "bright_red",
+        "bright_green",
+        "bright_yellow",
+        "bright_blue",
+        "bright_magenta",
+        "bright_cyan",
+    ]
+
+    # Dictionary to store ID to color mapping
+    id_color_map = {}
+
+    try:
+        async with aclosing(client.log_stream(log_level.value.lower())) as stream:
+            async for entry in stream:
+                # Get current timestamp with automatic timezone offset
+                now = datetime.now().astimezone()
+                timestamp = now.strftime("%z %Y-%m-%d %H:%M:%S")
+
+                # Get level color
+                # Start building the output message
+                message = Text()
+                message.append(timestamp, style="bright_black")
+                message.append(" ")
+                message.append(
+                    entry.type.upper(),
+                    style=log_level_colors.get(entry.type.lower(), "bright_white"),
+                )
+                message.append(" ")
+
+                # Process the payload
+                payload = entry.payload
+
+                # Find all ID patterns in the payload
+                pattern = r"\[(\d+) (\d+ms)\]"
+                last_end = 0
+
+                for match in re.finditer(pattern, payload):
+                    # Add text before the match
+                    message.append(payload[last_end : match.start()])
+
+                    # Extract ID and time part
+                    log_id = match.group(1)
+                    time_part = match.group(2)
+
+                    # Assign a consistent color to this ID
+                    if log_id not in id_color_map:
+                        color_index = hash(log_id) % len(id_colors)
+                        id_color_map[log_id] = id_colors[color_index]
+
+                    id_color = id_color_map[log_id]
+
+                    # Add the ID with coloring
+                    message.append("[", style="default")
+                    message.append(log_id, style=id_color)
+                    message.append(f" {time_part}]", style="default")
+
+                    last_end = match.end()
+
+                # Add any remaining text
+                if last_end < len(payload):
+                    message.append(payload[last_end:])
+
+                # Print the complete message
+                print(message)
+    except Exception as e:
+        print(f"[red]Error:[/red] {e}")
+        raise