Skip to main content

ChatArch proxy toolkit for Clash, subconverter, and proxy service operations.

Project description

chatclash

ChatArch single-machine proxy toolkit for Mihomo runtime management, subscription-backed config generation, and local proxy checks.

Quick start

pip install -e ".[dev]"
chatclash init
chatclash sub set -i
# If the subscription source blocks direct server fetches, use:
chatclash sub set --fetch-proxy local
chatclash mihomo install --daemon
chatclash sub update
chatclash mihomo start
chatclash status
chatclash check proxy
chatclash check ip

CLI tree

chatclash
├── init
├── status
├── sub
│   ├── set
│   ├── status
│   ├── update
│   ├── url
│   └── generate
├── proxy
│   ├── set
│   ├── show
│   └── env
├── mihomo
│   ├── install
│   ├── uninstall
│   ├── update
│   ├── start
│   ├── stop
│   ├── restart
│   ├── status
│   └── logs
└── check
    ├── proxy
    └── ip

Common commands

chatclash sub status
chatclash proxy set --http-port 7890 --socks-port 7891 --controller-port 9090
chatclash sub update
chatclash mihomo update
chatclash mihomo restart
chatclash mihomo logs
chatclash proxy show
eval "$(chatclash proxy env)"
python -m pytest -q

ChatArch conventions

  • CLI interaction uses ChatStyle helpers and the shared -i/-I pattern where applicable.
  • Operator config is stored through ChatEnv; local config stores only machine-local runtime facts.
  • Major CLI capabilities have reusable Python APIs under src/chatclash/ modules.
  • Sensitive values must not be printed in CLI output, logs, docs, or tests.

ChatEnv fields

Field Notes
CHATCLASH_SUBSCRIPTION_URL Subscription URL, sensitive
CHATCLASH_PROXY_AUTH Proxy authentication, sensitive
CHATCLASH_SUBCONVERTER_URL Optional subconverter service base URL
CHATCLASH_SUBSCRIPTION_FETCH_PROXY Subscription fetch proxy; local uses this machine's proxy

Machine-local ports, hosts, runtime paths, PID files, and log files live in ChatClash local config rather than ChatEnv.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chatclash-0.1.1.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chatclash-0.1.1-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file chatclash-0.1.1.tar.gz.

File metadata

  • Download URL: chatclash-0.1.1.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for chatclash-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0c8d76a4e01090c2489c6c738a25bb13279edc9547631b5d0e940bd73767f7d4
MD5 749125150188a9f22a2badbe9d802809
BLAKE2b-256 53e6b8d1bd68974df2ac2fd3e79570ec2adef64582979f677dbb5c911525b415

See more details on using hashes here.

File details

Details for the file chatclash-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: chatclash-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for chatclash-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e91cfede349a54cf2d54caefc54282aef99fccdb951bc94fdf837a3d3230742e
MD5 014efe086a617819db19cc36f0785382
BLAKE2b-256 caab11e0d71c7295b85eddee4224cd9c8d2a5fce92f9c2056c6d0a9ab19d0f07

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page