clashctl 0.1.0__tar.gz

clashctl-0.1.0/.github/workflows/pylint.yml

@@ -0,0 +1,23 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

clashctl-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

clashctl-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

clashctl-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Zixuan Tan
+
+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.

clashctl-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: clashctl
+Version: 0.1.0
+Summary: TUI for the Clash/Mihomo proxy
+Author-email: Zixuan Tan <tanzixuan.me@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: platformdirs>=4.2
+Requires-Dist: pydantic-settings>=2.3
+Requires-Dist: pydantic>=2.7
+Requires-Dist: textual>=0.85
+Requires-Dist: tomli-w>=1.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-textual-snapshot>=0.4; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# clashctl
+
+Python 3 rewrite of [clashctl](https://github.com/George-Miao/clashctl) — a [Textual](https://textual.textualize.io/)-based TUI for the [Clash](https://github.com/Dreamacro/clash) (and [mihomo](https://github.com/MetaCubeX/mihomo)) external-controller REST API.
+
+A live dashboard with five tabs: **Status / Proxies / Rules / Conns / Logs**. Server management lives entirely inside the TUI — no `add`/`use`/`del` subcommands.
+
+```text
+┌─ Status ───────────────────────────────────────────────────┐
+│ ⇉ Connections        12 │  ▲ ▁▁▃▂▄▇▆▆▅▇▆▆▆▆▇▆▅▆▇▆▆▇▇▆▇▆▆▇  │
+│ ▲ Upload     12.4 KiB/s │  ▼ ▁▂▁▁▂▁▁▁▁▂▂▂▂▁▂▂▁▂▁▂▁▂▁▁▂▁▂▁  │
+│ ▼ Download    1.2 MiB/s │                                  │
+│ ▲ Avg.        9.1 KiB/s │  max ↑ 487 KiB/s  ↓ 4.3 MiB/s    │
+│ ▼ Avg.        812 KiB/s │                                  │
+│ Clash Ver.      v1.18.0 │                                  │
+└────────────────────────────────────────────────────────────┘
+```
+
+## Status
+
+**MVP complete** — all five tabs functional, in-TUI server management, 213 unit tests, headless E2E verified.
+
+Notable differences from the Rust original:
+
+- **Real instantaneous connection speeds** (the Rust version reports `total_bytes / seconds_since_connection_start`, which mis-represents short bursts; here speeds are computed by diffing successive `/connections` polls).
+- **`ConnSort` is actually implemented** (the Rust counterpart was `todo!()` for all 11 keys).
+- **Config in TOML** instead of RON.
+- **Server management lives in the TUI**, not in CLI subcommands.
+
+## Install
+
+```bash
+git clone https://github.com/frezcirno/clashctl.git
+cd clashctl
+pip install -e ".[dev]"           # editable + test deps
+# or, with uv:
+uv pip install -e ".[dev]"
+```
+
+Python 3.11 or newer is required.
+
+## Run
+
+```bash
+clashctl                           # default config path
+clashctl -c /path/to/config.toml   # custom path
+clashctl --debug                   # verbose log to /tmp/clashctl.log
+```
+
+On first launch with no configured server, a modal pops up and walks you through adding one. The form probes `/version` against the supplied URL before saving so typos and bad secrets are caught early.
+
+## Keybindings
+
+### Global (any tab)
+
+| Key           | Action                                         |
+| ------------- | ---------------------------------------------- |
+| `q`, `Ctrl+C` | Quit                                           |
+| `1`–`5`       | Switch tabs                                    |
+| `Ctrl+S`      | Open the server picker (add / delete / switch) |
+
+### Tab-specific
+
+| Tab     | Key                  | Action                                                                                       |
+| ------- | -------------------- | -------------------------------------------------------------------------------------------- |
+| Proxies | `t`                  | Test latency for the focused group's normal members (parallel, capped at 8)                  |
+| Proxies | `Enter`              | On a member of a Selector group: switch to it (PUT `/proxies/<group>`)                       |
+| Proxies | `s` / `Shift+s`      | Cycle member sort (name / type / delay × asc / desc)                                         |
+| Rules   | `s` / `Shift+s`      | Cycle sort (payload / type / proxy × asc / desc)                                             |
+| Rules   | `Space`              | Toggle HOLD mode (cursor pinned across refreshes)                                            |
+| Rules   | `↑↓`                 | Navigate (in HOLD)                                                                           |
+| Rules   | `Esc`                | Exit HOLD                                                                                    |
+| Conns   | `s` / `Shift+s`      | Cycle sort across 11 keys (host, ▼, ▲, speeds, time, rule, chain, src, dst, type) × asc/desc |
+| Conns   | `Space`, `Esc`, `↑↓` | Same HOLD behavior as Rules                                                                  |
+
+### Server picker
+
+| Key           | Action                                     |
+| ------------- | ------------------------------------------ |
+| `a`           | Add a new server (opens form)              |
+| `d`           | Delete the focused server                  |
+| `u` / `Enter` | Use the focused server (swaps connections) |
+| `Esc`         | Close (or quit on first run)               |
+
+## Config
+
+Stored at `~/.config/clashctl/config.toml` by default (respects `$XDG_CONFIG_HOME`; on macOS it lands under `~/Library/Application Support/clashctl/`). Override the path with `-c <path>` or `CLASHCTL_CONFIG_PATH=...`.
+
+Schema:
+
+```toml
+using = "http://127.0.0.1:9090"
+
+[[servers]]
+name = "local"
+url = "http://127.0.0.1:9090"
+secret = ""                             # empty == no auth
+
+[[servers]]
+name = "remote"
+url = "https://proxy.example.com:9090"
+secret = "hunter2"
+
+[ui]
+test_url = "http://www.gstatic.com/generate_204"
+test_timeout_ms = 5000
+log_buffer = 2000                       # in-memory log line cap
+traffic_history = 500                   # sparkline samples
+refresh_slow_secs = 5.0                 # /version, /configs, /proxies, /rules
+refresh_fast_secs = 1.0                 # /connections
+
+[ui.sort]
+proxies     = { by = "delay",   order = "asc"  }
+rules       = { by = "payload", order = "asc"  }
+connections = { by = "time",    order = "desc" }
+```
+
+The TOML can be hand-edited; the TUI rewrites it via `tomli_w` whenever you add/use/delete a server.
+
+## Architecture
+
+```text
+src/clashctl/
+├── api/        # httpx async client + line-delimited JSON streams
+├── models/     # pydantic v2 models for every Clash payload
+├── state/      # AppState (single source of truth) + sort + speed tracker
+├── config/     # TOML load/save + AppConfig schema
+├── tui/        # Textual app, screens, widgets, polling worker
+└── utils/      # bytesize / duration helpers
+```
+
+- **Pollers** are plain asyncio classes that post `Message`s up the Textual tree; the App reduces messages into `AppState` and tells the active screen what to refresh.
+- **Layering rule**: `api/`, `models/`, `state/`, `config/` never import Textual — they're unit-testable without spinning up an `App`.
+- **Hidden tabs**: `RichLog.write()` produces empty strips when the widget has no width, so the Logs tab buffers in `AppState.logs` and replays on tab activation.
+
+## Test
+
+```bash
+pytest                  # 213 tests, ~9s
+ruff check src tests    # lint
+mypy src                # type check (strict mode)
+```
+
+Tests are split between pure unit coverage (models, sort, speed tracker, config round-trip) and Textual `run_test()` harnesses for widgets and screens. The API client is exercised against `httpx.MockTransport` with recorded fixtures under `tests/fixtures/`.
+
+## License
+
+MIT — see [LICENSE](../LICENSE).

clashctl-0.1.0/README.md

@@ -0,0 +1,147 @@
+# clashctl
+
+Python 3 rewrite of [clashctl](https://github.com/George-Miao/clashctl) — a [Textual](https://textual.textualize.io/)-based TUI for the [Clash](https://github.com/Dreamacro/clash) (and [mihomo](https://github.com/MetaCubeX/mihomo)) external-controller REST API.
+
+A live dashboard with five tabs: **Status / Proxies / Rules / Conns / Logs**. Server management lives entirely inside the TUI — no `add`/`use`/`del` subcommands.
+
+```text
+┌─ Status ───────────────────────────────────────────────────┐
+│ ⇉ Connections        12 │  ▲ ▁▁▃▂▄▇▆▆▅▇▆▆▆▆▇▆▅▆▇▆▆▇▇▆▇▆▆▇  │
+│ ▲ Upload     12.4 KiB/s │  ▼ ▁▂▁▁▂▁▁▁▁▂▂▂▂▁▂▂▁▂▁▂▁▂▁▁▂▁▂▁  │
+│ ▼ Download    1.2 MiB/s │                                  │
+│ ▲ Avg.        9.1 KiB/s │  max ↑ 487 KiB/s  ↓ 4.3 MiB/s    │
+│ ▼ Avg.        812 KiB/s │                                  │
+│ Clash Ver.      v1.18.0 │                                  │
+└────────────────────────────────────────────────────────────┘
+```
+
+## Status
+
+**MVP complete** — all five tabs functional, in-TUI server management, 213 unit tests, headless E2E verified.
+
+Notable differences from the Rust original:
+
+- **Real instantaneous connection speeds** (the Rust version reports `total_bytes / seconds_since_connection_start`, which mis-represents short bursts; here speeds are computed by diffing successive `/connections` polls).
+- **`ConnSort` is actually implemented** (the Rust counterpart was `todo!()` for all 11 keys).
+- **Config in TOML** instead of RON.
+- **Server management lives in the TUI**, not in CLI subcommands.
+
+## Install
+
+```bash
+git clone https://github.com/frezcirno/clashctl.git
+cd clashctl
+pip install -e ".[dev]"           # editable + test deps
+# or, with uv:
+uv pip install -e ".[dev]"
+```
+
+Python 3.11 or newer is required.
+
+## Run
+
+```bash
+clashctl                           # default config path
+clashctl -c /path/to/config.toml   # custom path
+clashctl --debug                   # verbose log to /tmp/clashctl.log
+```
+
+On first launch with no configured server, a modal pops up and walks you through adding one. The form probes `/version` against the supplied URL before saving so typos and bad secrets are caught early.
+
+## Keybindings
+
+### Global (any tab)
+
+| Key           | Action                                         |
+| ------------- | ---------------------------------------------- |
+| `q`, `Ctrl+C` | Quit                                           |
+| `1`–`5`       | Switch tabs                                    |
+| `Ctrl+S`      | Open the server picker (add / delete / switch) |
+
+### Tab-specific
+
+| Tab     | Key                  | Action                                                                                       |
+| ------- | -------------------- | -------------------------------------------------------------------------------------------- |
+| Proxies | `t`                  | Test latency for the focused group's normal members (parallel, capped at 8)                  |
+| Proxies | `Enter`              | On a member of a Selector group: switch to it (PUT `/proxies/<group>`)                       |
+| Proxies | `s` / `Shift+s`      | Cycle member sort (name / type / delay × asc / desc)                                         |
+| Rules   | `s` / `Shift+s`      | Cycle sort (payload / type / proxy × asc / desc)                                             |
+| Rules   | `Space`              | Toggle HOLD mode (cursor pinned across refreshes)                                            |
+| Rules   | `↑↓`                 | Navigate (in HOLD)                                                                           |
+| Rules   | `Esc`                | Exit HOLD                                                                                    |
+| Conns   | `s` / `Shift+s`      | Cycle sort across 11 keys (host, ▼, ▲, speeds, time, rule, chain, src, dst, type) × asc/desc |
+| Conns   | `Space`, `Esc`, `↑↓` | Same HOLD behavior as Rules                                                                  |
+
+### Server picker
+
+| Key           | Action                                     |
+| ------------- | ------------------------------------------ |
+| `a`           | Add a new server (opens form)              |
+| `d`           | Delete the focused server                  |
+| `u` / `Enter` | Use the focused server (swaps connections) |
+| `Esc`         | Close (or quit on first run)               |
+
+## Config
+
+Stored at `~/.config/clashctl/config.toml` by default (respects `$XDG_CONFIG_HOME`; on macOS it lands under `~/Library/Application Support/clashctl/`). Override the path with `-c <path>` or `CLASHCTL_CONFIG_PATH=...`.
+
+Schema:
+
+```toml
+using = "http://127.0.0.1:9090"
+
+[[servers]]
+name = "local"
+url = "http://127.0.0.1:9090"
+secret = ""                             # empty == no auth
+
+[[servers]]
+name = "remote"
+url = "https://proxy.example.com:9090"
+secret = "hunter2"
+
+[ui]
+test_url = "http://www.gstatic.com/generate_204"
+test_timeout_ms = 5000
+log_buffer = 2000                       # in-memory log line cap
+traffic_history = 500                   # sparkline samples
+refresh_slow_secs = 5.0                 # /version, /configs, /proxies, /rules
+refresh_fast_secs = 1.0                 # /connections
+
+[ui.sort]
+proxies     = { by = "delay",   order = "asc"  }
+rules       = { by = "payload", order = "asc"  }
+connections = { by = "time",    order = "desc" }
+```
+
+The TOML can be hand-edited; the TUI rewrites it via `tomli_w` whenever you add/use/delete a server.
+
+## Architecture
+
+```text
+src/clashctl/
+├── api/        # httpx async client + line-delimited JSON streams
+├── models/     # pydantic v2 models for every Clash payload
+├── state/      # AppState (single source of truth) + sort + speed tracker
+├── config/     # TOML load/save + AppConfig schema
+├── tui/        # Textual app, screens, widgets, polling worker
+└── utils/      # bytesize / duration helpers
+```
+
+- **Pollers** are plain asyncio classes that post `Message`s up the Textual tree; the App reduces messages into `AppState` and tells the active screen what to refresh.
+- **Layering rule**: `api/`, `models/`, `state/`, `config/` never import Textual — they're unit-testable without spinning up an `App`.
+- **Hidden tabs**: `RichLog.write()` produces empty strips when the widget has no width, so the Logs tab buffers in `AppState.logs` and replays on tab activation.
+
+## Test
+
+```bash
+pytest                  # 213 tests, ~9s
+ruff check src tests    # lint
+mypy src                # type check (strict mode)
+```
+
+Tests are split between pure unit coverage (models, sort, speed tracker, config round-trip) and Textual `run_test()` harnesses for widgets and screens. The API client is exercised against `httpx.MockTransport` with recorded fixtures under `tests/fixtures/`.
+
+## License
+
+MIT — see [LICENSE](../LICENSE).