NoneBot-Plugin-Clash

✨ 在 NoneBot2 中管理 Clash ✨

💿 安装

以下提到的方法 任选其一 即可

[推荐] 使用 nb-cli 安装

在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

nb plugin install nonebot-plugin-clash

使用包管理器安装

在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

pip

pip install nonebot-plugin-clash

pdm

pdm add nonebot-plugin-clash

poetry

poetry add nonebot-plugin-clash

conda

conda install nonebot-plugin-clash

打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分的 plugins 项里追加写入

[tool.nonebot]
plugins = [
    # ...
    "nonebot_plugin_clash"
]

⚙️ 配置

在 NoneBot2 项目的.env文件中添加下表中的必填配置

配置项	必填	默认值	说明
CLASH_CONTROLLER_URL	$${\textsf{\color{red}是}}$$	无	Clash 的 external-controller 地址，需要带上 http://
CLASH_SECRET	否	无	Clash 的 external-controller 使用的 secret
CLASH_NEED_SUPERUSER	否	True	是否只有 SUPERUSER 可以触发插件指令
CLASH_CHART_WIDTH	否	150	概览中图标的 X 轴最大点数
CLASH_LOG_LEVEL	否	info	监控的日志等级
CLASH_LOG_COUNT	否	50	保留的日志条数
CLASH_IMAGE_WIDTH	否	600	生成的图片宽度，单位像素（实际结果可能会为此值的两倍）

🎉 使用

指令

clash概览

获取当前 Clash 的运行状态概览

示例（点击展开）

clash日志

获取已记录的 Clash 日志

示例（点击展开）

clash清空日志

清空 Clash 日志记录

📞 联系

QQ：3076823485
Telegram：@lgc2333
吹水群：1105946125
邮箱：[email protected]

💡 鸣谢

haishanh/yacd

• 样式借鉴

💰 赞助

赞助我

感谢大家的赞助！你们的赞助将是我继续创作的动力！

📝 更新日志

芝士刚刚发布的插件，还没有更新日志的说 qwq~