sing-box-cli 0.1.6__tar.gz → 0.1.8__tar.gz

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sing-box-cli
-Version: 0.1.6
+Version: 0.1.8
 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

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/docs/config-serve.md

@@ -33,9 +33,9 @@ every token for that file without affecting other files. Multiple tokens may
 authorize the same file, so rotation can create a replacement before revoking the
 old token. Revocation never prints the secret.
 
-The longer `config serve token -l/-c/-r` forms remain supported. The previous
-`config serve token create/list/revoke` subcommands remain hidden compatibility
-aliases; the legacy `revoke NAME` form still accepts a token name.
+Token management uses only the top-level `sbc token` options. The previous
+`config serve token` entry point and `token create/list/revoke` subcommands have
+been removed.
 
 Clients can send the token as a Bearer header using `-t` / `--token`, or use the
 printed URL with `?token=...` in applications that cannot set headers:

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/pyproject.toml

@@ -215,7 +215,7 @@ topo_order = false
 sort_commits = "oldest"
 
 [tool.bumpversion]
-current_version        = "0.1.6"
+current_version        = "0.1.8"
 parse                  = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize              = ["{major}.{minor}.{patch}"]
 search                 = "{current_version}"

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/src/sing_box_cli/__init__.py

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

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/src/sing_box_cli/api/__init__.py

@@ -2,12 +2,13 @@ import asyncio
 from collections.abc import Callable, Coroutine
 from typing import Annotated, Any
 
+import httpx
 import typer
 
 from ..common import LogLevel, StrOrNone
 from ..config.config import ConfigHandler
 from ..service import get_context_obj
-from .client import SingBoxAPIClient
+from .client import SingBoxAPIClient, SingBoxAPIError
 from .connections import ConnectionsManager
 from .logs import get_logs
 from .monitor import ResourceMonitor, ResourceVisualizer
@@ -67,6 +68,12 @@ def _run_tui(
         asyncio.run(command(api_client))
     except (KeyboardInterrupt, EOFError):
         pass
+    except SingBoxAPIError as e:
+        typer.echo(f"Error: {e}", err=True)
+        raise typer.Exit(1)
+    except httpx.HTTPError as e:
+        typer.echo(f"Error: sing-box API request failed: {e}", err=True)
+        raise typer.Exit(1)
     print("Exited.")
 
 

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/src/sing_box_cli/api/client.py

@@ -104,6 +104,10 @@ class LogEntry(FrozenBaseModel):
 T = TypeVar("T", bound=FrozenBaseModel)
 
 
+class SingBoxAPIError(Exception):
+    """The sing-box API is unreachable or rejected the client."""
+
+
 class SingBoxAPIClient:
     """Async client for interacting with Sing-Box API.
 
@@ -123,7 +127,10 @@ class SingBoxAPIClient:
         self.headers = {"Authorization": f"Bearer {token}"} if token else {}
         self.timeout = timeout
         if not self._health_check():
-            raise ValueError(f"Invalid to initialize client: {self.base_url}")
+            raise SingBoxAPIError(
+                f"sing-box API is not reachable at {self.base_url}, "
+                "check that sing-box is running and the API URL and token are correct"
+            )
 
     def _health_check(self) -> bool:
         """Check if the API is reachable.
@@ -204,9 +211,11 @@ class SingBoxAPIClient:
         """
         url = f"{self.base_url}{endpoint}"
 
+        # streams may stay idle for long, so only reads are unbounded
+        timeout = httpx.Timeout(self.timeout, read=None)
         async with httpx.AsyncClient() as client:
             async with client.stream(
-                "GET", url, headers=self.headers, params=params, timeout=None
+                "GET", url, headers=self.headers, params=params, timeout=timeout
             ) as response:
                 response.raise_for_status()
                 async for line in response.aiter_lines():

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/src/sing_box_cli/api/connections.py

@@ -440,10 +440,18 @@ class ConnectionsManager:
                     pass
 
     async def periodic_refresh(self, interval: float = 0.5) -> None:
-        """Periodically refresh connections."""
+        """Periodically refresh connections, retrying while the API is unreachable."""
+        failed = False
         while self.running:
             try:
                 await asyncio.sleep(interval)
                 await self.refresh_connections()
             except asyncio.CancelledError:
                 break
+            except Exception:
+                # refresh_connections already shows the error in the status bar
+                failed = True
+                continue
+            if failed:
+                failed = False
+                self.status_message = self.get_filter_state()

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

@@ -0,0 +1,89 @@
+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 = {}
+
+    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)

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/src/sing_box_cli/api/monitor.py

@@ -2,6 +2,7 @@ import asyncio
 import math
 import statistics
 from collections import deque
+from collections.abc import AsyncGenerator, Callable
 from contextlib import aclosing
 from datetime import datetime
 from enum import Enum
@@ -14,7 +15,13 @@ from rich.panel import Panel
 from rich.table import Table
 from rich.text import Text
 
-from .client import ConnectionInfo, MemoryData, SingBoxAPIClient, TrafficData
+from .client import (
+    ConnectionInfo,
+    FrozenBaseModel,
+    MemoryData,
+    SingBoxAPIClient,
+    TrafficData,
+)
 from .widget import RichPlotMixin, create_header_panel
 
 
@@ -575,7 +582,10 @@ class ResourceVisualizer:
         return table
 
     def create_resources_layout(
-        self, traffic_data: TrafficData, memory_data: MemoryData
+        self,
+        traffic_data: TrafficData,
+        memory_data: MemoryData,
+        api_error: str | None = None,
     ) -> Layout:
         """Create the main layout with all resource components."""
         layout = Layout()
@@ -617,7 +627,17 @@ class ResourceVisualizer:
         )
 
         # Add footer
-        layout["footer"].update(Text("Press Ctrl+C to exit", justify="center"))
+        if api_error:
+            footer = Text(
+                f"{api_error} | Press Ctrl+C to exit",
+                style="bold red",
+                justify="center",
+                no_wrap=True,
+                overflow="ellipsis",
+            )
+        else:
+            footer = Text("Press Ctrl+C to exit", justify="center")
+        layout["footer"].update(footer)
 
         return layout
 
@@ -642,30 +662,44 @@ class ResourceMonitor:
         self.current_memory = MemoryData(inuse=0, total=0)  # in bytes
         # 1.0 fix interval for avoiding repeated data
         self.task_interval = RefreshRate.SLOW.value
+        self.reconnect_interval = RefreshRate.SLOW.value
+        self.api_error: str | None = None
 
     async def monitor_traffic(self) -> None:
         """Monitor traffic stream from the API."""
-        try:
-            async with aclosing(self.api_client.traffic_stream()) as stream:
-                async for traffic_data in stream:
-                    self.current_traffic = traffic_data
-                    if not self.running:
-                        break
-                    await asyncio.sleep(self.task_interval)
-        except Exception as e:
-            self.visualizer.console.print(f"[red]Error monitoring traffic: {str(e)}")
+        await self._follow_stream(
+            self.api_client.traffic_stream, "current_traffic", TrafficData()
+        )
 
     async def monitor_memory(self) -> None:
         """Monitor memory stream from the API."""
-        try:
-            async with aclosing(self.api_client.memory_stream()) as stream:
-                async for memory_data in stream:
-                    self.current_memory = memory_data
-                    if not self.running:
-                        break
-                    await asyncio.sleep(self.task_interval)
-        except Exception as e:
-            self.visualizer.console.print(f"[red]Error monitoring memory: {str(e)}")
+        await self._follow_stream(
+            self.api_client.memory_stream, "current_memory", MemoryData()
+        )
+
+    async def _follow_stream(
+        self,
+        open_stream: Callable[[], AsyncGenerator[FrozenBaseModel, None]],
+        attr: str,
+        empty: FrozenBaseModel,
+    ) -> None:
+        """Keep ``attr`` updated from a stream, reopening it whenever it ends."""
+        while self.running:
+            try:
+                async with aclosing(open_stream()) as stream:
+                    async for data in stream:
+                        setattr(self, attr, data)
+                        self.api_error = None
+                        if not self.running:
+                            return
+                        await asyncio.sleep(self.task_interval)
+                reason = "closed by sing-box"
+            except Exception as e:
+                reason = str(e) or type(e).__name__
+            # don't keep showing stale numbers while sing-box is down
+            setattr(self, attr, empty)
+            self.api_error = f"sing-box API stream lost ({reason}), reconnecting..."
+            await asyncio.sleep(self.reconnect_interval)
 
     async def refresh_display(self) -> None:
         """Main display refresh loop."""
@@ -685,7 +719,7 @@ class ResourceMonitor:
 
                         # Update display
                         layout = self.visualizer.create_resources_layout(
-                            traffic_data, memory_data
+                            traffic_data, memory_data, self.api_error
                         )
                         live.update(layout)
 

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/src/sing_box_cli/config/serve.py

@@ -25,17 +25,10 @@ from .serve_backend import (
     state_directory,
     validate_config,
 )
-from .serve_tokens import (
-    create_token,
-    load_tokens,
-    revoke_subscription_tokens,
-    revoke_token,
-)
+from .serve_tokens import create_token, load_tokens, revoke_subscription_tokens
 
 WORKER_MODULE = "sing_box_cli.config._serve_worker"
 serve = typer.Typer(help="Serve private GitHub configurations through your own domain.")
-tokens = typer.Typer(help="Create, list and revoke independent subscription tokens.")
-serve.add_typer(tokens, name="token")
 
 
 class ProcessState(BaseModel):
@@ -278,7 +271,6 @@ def start(
         print(f"Log: {directory / 'serve.log'}")
 
 
-@tokens.callback(invoke_without_command=True)
 def token_options(
     ctx: typer.Context,
     list_: Annotated[
@@ -310,12 +302,8 @@ def token_options(
         str | None, typer.Option("--name", "-n", help="Optional name for a new token.")
     ] = None,
 ) -> None:
-    """Manage subscription tokens with -l, -c FILE or -r TOKEN_OR_FILE."""
+    """Create, list and revoke independent subscription tokens."""
     actions = int(list_) + int(create is not None) + int(revoke is not None)
-    if ctx.invoked_subcommand is not None:
-        if actions or domain is not None or name is not None:
-            raise typer.BadParameter("Use options or a legacy subcommand, not both.")
-        return
     if actions == 0 and domain is None and name is None:
         print(ctx.get_help())
         return
@@ -348,18 +336,7 @@ def token_options(
             print(f"Revoked {count} subscription token(s).")
 
 
-@tokens.command("create", hidden=True)
-def token_create(
-    name: Annotated[
-        str, typer.Argument(help="Unique name for this subscription token.")
-    ],
-    domain: Annotated[
-        str, typer.Option("--domain", help="Registered subscription domain.")
-    ],
-    filename: Annotated[
-        str, typer.Option("--file", help="Root configuration filename.")
-    ],
-) -> None:
+def token_create(name: str, domain: str, filename: str) -> None:
     """Generate a file-scoped token and print its secret and URL once."""
     with command_errors():
         domain = normalize_domain(domain)
@@ -379,7 +356,6 @@ def token_create(
         print("Save the token now; only its hash is stored on the server.")
 
 
-@tokens.command("list", hidden=True)
 def token_list() -> None:
     """List token names and scopes without displaying their secrets."""
     with command_errors():
@@ -390,20 +366,6 @@ def token_list() -> None:
             print(f"{item.name}\t{item.domain}\t{item.filename}\t{item.created_at}")
 
 
-@tokens.command("revoke", hidden=True)
-def token_revoke(
-    name: Annotated[
-        str, typer.Argument(help="Name of the subscription token to revoke.")
-    ],
-) -> None:
-    """Revoke a token; the next request is denied without a service restart."""
-    with command_errors():
-        directory = state_directory()
-        with control_lock(directory):
-            revoke_token(directory, name)
-        print(f"Revoked subscription token: {name}")
-
-
 @serve.command("stop")
 def stop() -> None:
     """Stop this user's background configuration service."""

{sing_box_cli-0.1.6 → sing_box_cli-0.1.8}/src/sing_box_cli/main.py

@@ -9,7 +9,7 @@ from sing_box_cli.api import api as api_app
 from sing_box_cli.common import ClearCacheOption, UpdateConfigOption, ensure_root
 from sing_box_cli.config import config as config_app
 from sing_box_cli.config.config import get_config, run_args
-from sing_box_cli.config.serve import tokens as token_app
+from sing_box_cli.config.serve import token_options
 from sing_box_cli.installation import install_launchers
 from sing_box_cli.service import SharedContext, get_context_obj, service as service_app
 from sing_box_cli.service.manager import create_service
@@ -18,7 +18,7 @@ app = typer.Typer(help="sing-box manager.")
 app.add_typer(api_app)
 app.add_typer(service_app, name="service")
 app.add_typer(config_app, name="config")
-app.add_typer(token_app, name="token")
+app.command("token")(token_options)
 
 
 @app.callback(invoke_without_command=False)

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

@@ -1,93 +0,0 @@
-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