kctl-rustdesk 0.6.3__tar.gz

kctl_rustdesk-0.6.3/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Environment
+.env
+.env.local

kctl_rustdesk-0.6.3/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: kctl-rustdesk
+Version: 0.6.3
+Summary: Kodemeio RustDesk CLI — manage RustDesk server infrastructure
+Requires-Python: >=3.12
+Requires-Dist: kctl-lib>=0.8.0
+Requires-Dist: pydantic>=2.10.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=13.9.0
+Requires-Dist: typer>=0.15.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.14.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.35.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.0; extra == 'dev'
+Requires-Dist: ruff>=0.9.0; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0.0; extra == 'dev'

kctl_rustdesk-0.6.3/README.md

@@ -0,0 +1,72 @@
+# kctl-rustdesk
+
+Kodemeio RustDesk CLI — manage RustDesk server infrastructure.
+
+## Installation
+
+```bash
+uv tool install .
+```
+
+## Quick Start
+
+```bash
+kctl-rustdesk config init
+kctl-rustdesk health
+kctl-rustdesk dashboard
+kctl-rustdesk peers list
+```
+
+## Command Groups
+
+| Group | Description |
+|-------|-------------|
+| `config` | Manage CLI configuration and profiles |
+| `health` | Health checks for RustDesk server |
+| `dashboard` | System overview dashboard |
+| `peers` | Manage RustDesk peers (devices) |
+| `users` | Manage RustDesk users |
+| `audit` | Audit logs and connection history |
+| `backup` | Backup and restore RustDesk server data |
+| `setup` | Server setup and configuration |
+| `maintenance` | Maintenance and operational tasks |
+
+## Global Options
+
+| Option | Short | Description |
+|--------|-------|-------------|
+| `--json` | | Output as JSON |
+| `--quiet` | `-q` | Suppress info messages |
+| `--format` | `-f` | Output format: pretty, json, csv, yaml |
+| `--no-header` | | Omit column headers |
+| `--profile` | `-p` | Config profile |
+| `--host` | | Server host override |
+| `--version` | `-V` | Show version and exit |
+
+## Configuration
+
+Config lives in `~/.config/kodemeio/config.yaml` under the `rustdesk` service key.
+
+```bash
+# Initialize default profile
+kctl-rustdesk config init
+
+# Add a named profile
+kctl-rustdesk config add prod \
+  --host https://rustdesk.example.com \
+  --api-key $RUSTDESK_API_KEY
+
+# Switch active profile
+kctl-rustdesk config use prod
+
+# Show current profile (key masked)
+kctl-rustdesk config show
+```
+
+## Development
+
+```bash
+uv run pytest tests/ -v
+uv run ruff check src/
+uv run mypy src/
+```

kctl_rustdesk-0.6.3/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "kctl-rustdesk"
+version = "0.6.3"
+description = "Kodemeio RustDesk CLI — manage RustDesk server infrastructure"
+requires-python = ">=3.12"
+dependencies = [
+    "kctl-lib>=0.8.0",
+    "typer>=0.15.0",
+    "rich>=13.9.0",
+    "pydantic>=2.10.0",
+    "pyyaml>=6.0.2",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3.0",
+    "pytest-httpx>=0.35.0",
+    "ruff>=0.9.0",
+    "mypy>=1.14.0",
+    "types-PyYAML>=6.0.0",
+]
+
+[project.scripts]
+kctl-rustdesk = "kctl_rustdesk.cli:_run"
+
+[tool.uv.sources]
+kctl-lib = { workspace = true }
+
+[project.entry-points."kctl_rustdesk.plugins"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/kctl_rustdesk"]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 120
+
+[tool.mypy]
+python_version = "3.12"
+strict = true

kctl_rustdesk-0.6.3/skills/rustdesk-admin/SKILL.md

@@ -0,0 +1,160 @@
+---
+name: rustdesk-admin
+description: >
+  RustDesk remote desktop administration via kctl-rustdesk CLI (10 groups, ~36 commands).
+  MUST use for ANY kctl-rustdesk operation.
+  Triggers on: "active", "audit", "backup", "check", "clean", "cleanup", "client-config", "config", "connections", "count", "dashboard", "db-optimize", "db-stats", "export", "firewall", "generate", "get-key", "groups", "health", "init", "kctl-rustdesk", "logins", "logs", "maintenance", "peers", "profile", "profiles", "restore", "search", "setup", "skill", "stats", "test", "users", "version".
+  Auto-generated: 2026-04-05
+  registry_hash: 74352b3f8a29
+---
+
+# rustdesk-admin — kctl-rustdesk CLI Reference
+
+> Auto-generated from `kctl-rustdesk` command registry. Do not edit manually.
+> To regenerate: `kctl-rustdesk skill generate`
+> To add custom content: edit `SKILL.extra.md` in the same directory.
+
+## Overview
+
+**CLI:** `kctl-rustdesk`
+**Command groups:** 10
+**Total commands:** ~36
+**Install:** `cd cli && uv tool install --editable .`
+
+## Global Options
+
+| Flag | Description |
+|------|-------------|
+| `--json` | JSON output |
+| `--quiet`, `-q` | Suppress info messages |
+| `--format`, `-f` | Output format: pretty/json/csv/yaml |
+| `--no-header` | Omit CSV header row |
+| `--profile`, `-p` | Config profile name |
+| `--version`, `-V` | Show version |
+
+## Command Reference
+
+### `kctl-rustdesk audit`
+
+Audit logs and connection history.
+
+| Command | Description |
+|---------|-------------|
+| `audit active` | Show currently active sessions. |
+| `audit connections [--today] [--limit]` | Show connection history. |
+| `audit logins [--failed] [--limit]` | Show login history. |
+| `audit stats` | Show connection statistics. |
+
+### `kctl-rustdesk backup`
+
+Backup and restore RustDesk server data.
+
+| Command | Description |
+|---------|-------------|
+| `backup clean [--days]` | Remove old backups. |
+| `backup create` | Create a backup of keys and database. |
+| `backup list` | List available backups. |
+| `backup restore <backup_file>` | Restore from a backup file. |
+
+### `kctl-rustdesk config`
+
+Manage CLI configuration and profiles.
+
+| Command | Description |
+|---------|-------------|
+| `config init [--host] [--ssh_user] [--compose_file] [--env_file] [--project_name] [--domain] [--name]` | Initialize CLI configuration with a new profile. |
+| `config profiles` | List all profiles. |
+| `config show` | Show current configuration. |
+| `config test` | Test connection to the RustDesk server. |
+| `config use <name>` | Set the default profile. |
+
+### `kctl-rustdesk dashboard`
+
+System overview dashboard.
+
+| Command | Description |
+|---------|-------------|
+| `dashboard show [--compact]` | Show system overview dashboard. |
+
+### `kctl-rustdesk health`
+
+Health checks for RustDesk server.
+
+| Command | Description |
+|---------|-------------|
+| `health check [--as_json]` | Run health checks on RustDesk server. |
+
+### `kctl-rustdesk maintenance`
+
+Maintenance and operational tasks.
+
+| Command | Description |
+|---------|-------------|
+| `maintenance cleanup` | Clean up unused Docker resources. |
+| `maintenance db-optimize` | Optimize the SQLite database (VACUUM + ANALYZE). |
+| `maintenance db-stats` | Show database statistics. |
+| `maintenance logs [--service] [--lines]` | View container logs. |
+| `maintenance status` | Show container status and resource usage. |
+| `maintenance version` | Show version information. |
+
+### `kctl-rustdesk peers`
+
+Manage RustDesk peers (devices).
+
+| Command | Description |
+|---------|-------------|
+| `peers count` | Count total peers. |
+| `peers export` | Export all peers as JSON. |
+| `peers get <peer_id>` | Get details for a specific peer. |
+| `peers list [--online]` | List all registered peers. |
+| `peers search <term>` | Search peers by ID, UUID, or note. |
+
+### `kctl-rustdesk setup`
+
+Server setup and configuration.
+
+| Command | Description |
+|---------|-------------|
+| `setup client-config` | Generate RustDesk client configuration string. |
+| `setup firewall` | Show required firewall rules. |
+| `setup get-key` | Display the server's public key. |
+| `setup status` | Show setup status checklist. |
+
+### `kctl-rustdesk skill`
+
+Claude Code skill management.
+
+| Command | Description |
+|---------|-------------|
+| `skill generate [--output] [--install] [--check]` | Auto-generate SKILL.md from CLI command registry. |
+
+**Examples:**
+```bash
+kctl-rustdesk skill generate
+kctl-rustdesk skill generate --install
+kctl-rustdesk skill generate --check
+```
+
+### `kctl-rustdesk users`
+
+Manage RustDesk users.
+
+| Command | Description |
+|---------|-------------|
+| `users count` | Count users. |
+| `users export` | Export all users as JSON. |
+| `users get <username>` | Get details for a specific user. |
+| `users groups` | List user groups. |
+| `users list [--active]` | List all users. |
+
+## Configuration
+
+Shared config: `~/.config/kodemeio/config.yaml`
+
+```bash
+kctl-rustdesk config init       # Interactive setup
+kctl-rustdesk config show       # Show current config
+kctl-rustdesk config profiles   # List profiles
+kctl-rustdesk config current    # Show active profile
+kctl-rustdesk config validate   # Verify config
+```

kctl_rustdesk-0.6.3/src/kctl_rustdesk/__init__.py

@@ -0,0 +1,3 @@
+"""kctl-rustdesk: Kodemeio RustDesk server management CLI."""
+
+__version__ = "0.6.3"

kctl_rustdesk-0.6.3/src/kctl_rustdesk/__main__.py

@@ -0,0 +1,3 @@
+from kctl_rustdesk.cli import _run
+
+_run()

kctl_rustdesk-0.6.3/src/kctl_rustdesk/cli.py

@@ -0,0 +1,133 @@
+"""kctl-rustdesk CLI entry point."""
+
+from __future__ import annotations
+
+
+from typing import Annotated
+
+import typer
+
+from kctl_lib import handle_cli_error
+from kctl_lib.exceptions import KctlError
+
+from kctl_rustdesk import __version__
+from kctl_rustdesk.commands.audit import app as audit_app
+from kctl_rustdesk.commands.backup import app as backup_app
+from kctl_rustdesk.commands.config_cmd import app as config_app
+from kctl_rustdesk.commands.dashboard import app as dashboard_app
+from kctl_rustdesk.commands.health import app as health_app
+from kctl_rustdesk.commands.maintenance import app as maintenance_app
+from kctl_rustdesk.commands.peers import app as peers_app
+from kctl_rustdesk.commands.setup import app as setup_app
+from kctl_rustdesk.commands.users import app as users_app
+from kctl_rustdesk.core.plugins import discover_and_load_plugins
+from kctl_rustdesk.commands.skill_cmd import app as skill_app
+from kctl_rustdesk.commands.doctor_cmd import app as doctor_app
+from kctl_lib.self_update import notify_if_outdated
+from kctl_lib.tui import add_tui_command
+
+
+def version_callback(value: bool) -> None:
+    if value:
+        typer.echo(f"kctl-rustdesk {__version__}")
+        raise typer.Exit()
+
+
+app = typer.Typer(
+    name="kctl-rustdesk",
+    help="Kodemeio RustDesk CLI — manage RustDesk server infrastructure.",
+    no_args_is_help=True,
+    rich_markup_mode="rich",
+    pretty_exceptions_enable=False,
+)
+
+
+@app.callback()
+def main(
+    ctx: typer.Context,
+    json_output: Annotated[bool, typer.Option("--json", help="Output as JSON")] = False,
+    quiet: Annotated[bool, typer.Option("--quiet", "-q", help="Suppress info messages")] = False,
+    profile: Annotated[str | None, typer.Option("--profile", "-p", help="Config profile")] = None,
+    format: Annotated[str, typer.Option("--format", "-f", help="Output format")] = "pretty",
+    no_header: Annotated[bool, typer.Option("--no-header", help="Omit column headers")] = False,
+    host: Annotated[str | None, typer.Option("--host", help="Server host override")] = None,
+    version: Annotated[bool, typer.Option("--version", "-V", callback=version_callback, is_eager=True)] = False,
+) -> None:
+    """Manage RustDesk server infrastructure."""
+    from kctl_rustdesk.core.callbacks import AppContext
+
+    ctx.ensure_object(dict)
+    ctx.obj = AppContext(
+        json_mode=json_output,
+        quiet=quiet,
+        profile=profile,
+        format=format,
+        no_header=no_header,
+        host_override=host,
+    )
+    notify_if_outdated(ctx.obj.output, "kctl-rustdesk", __version__)
+
+
+app.add_typer(config_app, name="config")
+app.add_typer(health_app, name="health")
+app.add_typer(dashboard_app, name="dashboard")
+app.add_typer(peers_app, name="peers")
+app.add_typer(users_app, name="users")
+app.add_typer(audit_app, name="audit")
+app.add_typer(backup_app, name="backup")
+app.add_typer(setup_app, name="setup")
+app.add_typer(maintenance_app, name="maintenance")
+app.add_typer(skill_app, name="skill", hidden=True)
+app.add_typer(doctor_app, name="doctor")
+
+discover_and_load_plugins(app)
+add_tui_command(app, service_key="rustdesk", version=__version__)
+
+
+@app.command("self-update")
+def self_update_cmd(ctx: typer.Context) -> None:
+    """Check for updates and upgrade kctl-rustdesk."""
+    actx = ctx.obj
+    out = actx.output
+
+    from kctl_lib.self_update import check_update
+    from kctl_lib.self_update import update as do_update
+
+    latest = check_update("kctl-rustdesk", __version__)
+    if latest:
+        out.info(f"Updating to {latest}...")
+        do_update("kctl-rustdesk")
+        out.success(f"Updated to {latest}")
+    else:
+        out.success("Already up to date")
+
+
+@app.command()
+def completions(
+    shell: Annotated[str, typer.Argument(help="Shell type: zsh, bash, fish")] = "zsh",
+    install: Annotated[bool, typer.Option("--install", help="Install completions")] = False,
+) -> None:
+    """Generate or install shell completions."""
+    from kctl_lib.completions import get_completion_script, install_completions
+
+    if install:
+        path = install_completions("kctl-rustdesk", shell)
+        if path:
+            typer.echo(f"Completions installed to {path}")
+        else:
+            typer.echo(f"Could not install completions for {shell}", err=True)
+            raise typer.Exit(code=1)
+    else:
+        script = get_completion_script("kctl-rustdesk", shell)
+        typer.echo(script)
+
+
+def _run() -> None:
+    try:
+        app()
+    except KctlError as e:
+        handle_cli_error(e)
+
+
+if __name__ == "__main__":
+    _run()

kctl_rustdesk-0.6.3/src/kctl_rustdesk/commands/audit.py

@@ -0,0 +1,143 @@
+"""Audit log and connection history commands."""
+
+from __future__ import annotations
+
+from typing import Annotated
+
+import typer
+
+from kctl_rustdesk.core.callbacks import AppContext
+
+app = typer.Typer(help="Audit logs and connection history.")
+
+
+@app.command()
+def connections(
+    ctx: typer.Context,
+    today: Annotated[bool, typer.Option("--today", help="Only today")] = False,
+    limit: Annotated[int, typer.Option("--limit", "-n", help="Max rows")] = 50,
+) -> None:
+    """Show connection history."""
+    c: AppContext = ctx.obj
+    ex = c.executor
+
+    where = "WHERE date(created_at) = date('now')" if today else ""
+    sql = f"SELECT peer_id, ip, created_at FROM conn_log {where} ORDER BY created_at DESC LIMIT {limit};"
+
+    rows_data = ex.query_db(sql)
+    rows = [[r.get("peer_id", ""), r.get("ip", ""), r.get("created_at", "")] for r in rows_data]
+
+    title = "Connections (today)" if today else f"Connections (last {limit})"
+    c.output.table(
+        title,
+        [("Peer ID", "cyan"), ("IP", ""), ("Time", "dim")],
+        rows,
+        data_for_json=rows_data,
+    )
+
+
+@app.command()
+def logins(
+    ctx: typer.Context,
+    failed: Annotated[bool, typer.Option("--failed", help="Only failed logins")] = False,
+    limit: Annotated[int, typer.Option("--limit", "-n", help="Max rows")] = 50,
+) -> None:
+    """Show login history."""
+    c: AppContext = ctx.obj
+    ex = c.executor
+
+    where = "WHERE type != 0" if failed else ""
+    sql = f"SELECT user_id, ip, type, created_at FROM login_log {where} ORDER BY created_at DESC LIMIT {limit};"
+
+    rows_data = ex.query_db(sql)
+    rows = [
+        [
+            r.get("user_id", ""),
+            r.get("ip", ""),
+            "failed" if r.get("type", "0") != "0" else "ok",
+            r.get("created_at", ""),
+        ]
+        for r in rows_data
+    ]
+
+    title = "Failed Logins" if failed else f"Logins (last {limit})"
+    c.output.table(
+        title,
+        [("User", "cyan"), ("IP", ""), ("Status", ""), ("Time", "dim")],
+        rows,
+        data_for_json=rows_data,
+    )
+
+
+@app.command()
+def stats(ctx: typer.Context) -> None:
+    """Show connection statistics."""
+    c: AppContext = ctx.obj
+    ex = c.executor
+
+    total_conns = ex.query_db_scalar("SELECT count(*) FROM conn_log;")
+    today_conns = ex.query_db_scalar("SELECT count(*) FROM conn_log WHERE date(created_at) = date('now');")
+    unique_peers = ex.query_db_scalar("SELECT count(DISTINCT peer_id) FROM conn_log;")
+    unique_ips = ex.query_db_scalar("SELECT count(DISTINCT ip) FROM conn_log;")
+    total_logins = ex.query_db_scalar("SELECT count(*) FROM login_log;")
+    failed_logins = ex.query_db_scalar("SELECT count(*) FROM login_log WHERE type != 0;")
+
+    top_peers = ex.query_db("SELECT peer_id, count(*) as cnt FROM conn_log GROUP BY peer_id ORDER BY cnt DESC LIMIT 5;")
+
+    sections = [
+        (
+            "Connection Stats",
+            [
+                ("Total connections", total_conns),
+                ("Today", today_conns),
+                ("Unique peers", unique_peers),
+                ("Unique IPs", unique_ips),
+            ],
+        ),
+        (
+            "Login Stats",
+            [
+                ("Total logins", total_logins),
+                ("Failed logins", failed_logins),
+            ],
+        ),
+        ("Top Peers", [(p.get("peer_id", ""), f"{p.get('cnt', 0)} connections") for p in top_peers]),
+    ]
+
+    c.output.detail(
+        "Audit Statistics",
+        sections,
+        data_for_json={
+            "connections": {
+                "total": int(total_conns),
+                "today": int(today_conns),
+                "unique_peers": int(unique_peers),
+                "unique_ips": int(unique_ips),
+            },
+            "logins": {"total": int(total_logins), "failed": int(failed_logins)},
+            "top_peers": top_peers,
+        },
+    )
+
+
+@app.command()
+def active(ctx: typer.Context) -> None:
+    """Show currently active sessions."""
+    c: AppContext = ctx.obj
+    ex = c.executor
+
+    sql = (
+        "SELECT peer_id, ip, created_at FROM conn_log "
+        "WHERE created_at > datetime('now', '-5 minutes') "
+        "ORDER BY created_at DESC;"
+    )
+
+    rows_data = ex.query_db(sql)
+    rows = [[r.get("peer_id", ""), r.get("ip", ""), r.get("created_at", "")] for r in rows_data]
+
+    c.output.table(
+        "Active Sessions (last 5m)",
+        [("Peer ID", "cyan"), ("IP", ""), ("Connected", "dim")],
+        rows,
+        data_for_json=rows_data,
+    )