https://github.com/nonebot/cli-plugin-webui
Web UI for NoneBot CLI
https://github.com/nonebot/cli-plugin-webui
Last synced: about 1 year ago
JSON representation
Web UI for NoneBot CLI
- Host: GitHub
- URL: https://github.com/nonebot/cli-plugin-webui
- Owner: nonebot
- License: mit
- Created: 2023-04-05T07:33:17.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T15:18:10.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T09:04:12.629Z (almost 2 years ago)
- Language: Vue
- Homepage:
- Size: 769 KB
- Stars: 40
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NB CLI Plugin WebUI
_✨ NoneBot2 命令行工具 前端可视化页面（WebUI） 插件 ✨_
## 功能
- 可视化的 nb cli 操作
- 创建新的 NoneBot 实例
- 添加已有的 NoneBot 实例
- 拓展（插件、适配器、驱动器）管理（安装、卸载）
- 可同时管理多个 NoneBot 实例
- 为启动的 NoneBot 实例提供状态展示、性能查询
- 可视化的 NoneBot 实例配置
## 使用
### 安装
**需要 [nb-cli](https://github.com/nonebot/nb-cli/)**
使用 nb-cli 安装
```shell
nb self install nb-cli-plugin-webui
```
使用 Docker 运行
```shell
docker pull nonebot/cil-plugin-webui:latest
```
Docker 镜像可以选择以下版本:
- `latest`, `latest-slim`: 最新的稳定版本 (Release)
- `latest-${python 版本}`, `latest-slim-${python 版本}`: 指定 Python 版本的最新版本
- `sha-${commit sha:0:7}-${python 版本}`, `sha-${commit sha:0:7}-${python 版本}-slim`: 指定 commit 的版本
- `${branch}-${python 版本}`, `${branch}-${python 版本}-slim`: 指定分支的最新版本
### 命令行使用
```shell
nb ui --help
```
Docker 镜像使用
```shell
docker run -it --rm -p 8080:8080 -v ./:/app nonebot/cli-plugin-webui:latest --help
```
可选附加 env 参数:
- HOST: 指定监听地址，默认为 `0.0.0.0`
- PORT: 指定监听端口，默认为 `8080`
## 开发
待补充......
## 补充
nb-cli WebUI 目前正处于快速迭代中，欢迎各位提交在使用过程中发现的 BUG 和建议。