clashctl README

The project's README from github.com/nelvko/clashctl. As one markdown file: README.md.

clashctl

mihomo / clash 一键部署与管理工具

GitHub License GitHub top language GitHub Repo stars Ask DeepWiki

📸 Preview

preview

✨ Features

🚀 Installation

在终端中执行以下命令即可完成安装:

git clone --branch master --depth 1 https://gh-proxy.org/https://github.com/nelvko/clash-for-linux-install.git \
  && cd clash-for-linux-install \
  && bash install.sh

🎯 Quick Start

安装完成后,即可使用 clashctl 管理代理:

clashctl on              # 开启代理
clashctl off             # 关闭代理
clashctl status          # 查看内核状态
clashctl ui              # 查看 Web 面板地址

clashctl sub add <url>   # 添加订阅
clashctl sub update      # 更新订阅
clashctl node            # 切换节点

clashctl -h              # 查看全部命令

🧹 Uninstall

在项目目录下执行以下命令即可干净卸载(清除内核、配置及服务):

bash uninstall.sh

📖 Documentation

💖 Support

Maru Code Maru Code —— 稳定可靠的 API 中转服务

⭐ Star History

Star History Chart

⚠️ Disclaimer

clashctl (nelvko/clashctl)

Searching Database…

What is this?A Shell toolkit that one-click deploys and manages mihomo/clash proxy environments on Linux, handling the core, Web dashboard, and all runtime dependencies.
Is this a CLI tool or a GUI app?It is a command-line tool: after install you get a 'clashctl' command plus an optional browser-based Web dashboard for the proxy core.
How do I get it running?Run the provided install command in a terminal (with an acceleration prefix if needed, customizable via a .env.install file), then use 'clashctl' to start and manage the proxy.
Do I need a subscription link before installing?Yes, you need a proxy subscription URL to actually use it; the README links to a guide for users who don't have one yet.
What platforms and permissions does it support?It works with both root and regular users, and is designed to be compatible across mainstream Linux distributions, container environments, and both systemd and OpenRC init systems.
Can I manage multiple subscription sources?Yes, clashctl supports configuring multiple subscription sources and lets you add, switch, and update them, with built-in subconverter integration to convert between subscription formats.
How do I uninstall it cleanly?Run the project's uninstall command from the project directory, which removes the core, configuration files, and any registered services.
Does it support TUN mode?Yes, clashctl includes TUN mode management alongside proxy start/stop, status checks, log tracing, the Web dashboard, and access key and core upgrade handling.
Creator
nelvko
Size
78 MB
Stars
15K
Age
2y
Commits · 90 Days