<!-- markdownlint-disable MD033 MD041 -->
<p align="center">
<a href="https://cli.nonebot.dev/"><img src="https://cli.nonebot.dev/logo.png" width="200" height="200" alt="nonebot"></a>
</p>
<div align="center">
# NB CLI Plugin WebUI
_✨ NoneBot2 命令行工具 前端可视化页面（WebUI） 插件 ✨_
</div>
<p align="center">
<a href="https://raw.githubusercontent.com/nonebot/nb-cli-plugin-webui/master/LICENSE">
<img src="https://img.shields.io/github/license/nonebot/cli-plugin-webui" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nb-cli-plugin-webui">
<img src="https://img.shields.io/pypi/v/nb-cli-plugin-webui" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.8+-blue" alt="python">
<a href="https://results.pre-commit.ci/latest/github/nonebot/nb-cli-plugin-webui/master">
<img src="https://results.pre-commit.ci/badge/github/nonebot/cli-plugin-webui/master.svg" alt="pre-commit" />
</a>
<br />
<a href="https://jq.qq.com/?_wv=1027&k=5OFifDh">
<img src="https://img.shields.io/badge/QQ%E7%BE%A4-768887710-orange?style=flat-square" alt="QQ Chat Group">
</a>
<a href="https://qun.qq.com/qqweb/qunpro/share?_wv=3&_wwv=128&appChannel=share&inviteCode=7b4a3&appChannel=share&businessType=9&from=246610&biz=ka">
<img src="https://img.shields.io/badge/QQ%E9%A2%91%E9%81%93-NoneBot-5492ff?style=flat-square" alt="QQ Channel">
</a>
<a href="https://t.me/botuniverse">
<img src="https://img.shields.io/badge/telegram-botuniverse-blue?style=flat-square" alt="Telegram Channel">
</a>
<a href="https://discord.gg/VKtE6Gdc4h">
<img src="https://discordapp.com/api/guilds/847819937858584596/widget.png?style=shield" alt="Discord Server">
</a>
</p>
## 功能
- 可视化的 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 和建议。
Raw data
{
"_id": null,
"home_page": "https://github.com/nonebot/cli-plugin-webui",
"name": "nb-cli-plugin-webui",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": null,
"keywords": "nonebot, cli, web",
"author": "Kyomotoi",
"author_email": "kyomotoiowo@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/50/5c/26b8440e4100231aadc727c8978423d69ab1867bc0f788f4fe2d95e3a141/nb_cli_plugin_webui-0.4.2.tar.gz",
"platform": null,
"description": "<!-- markdownlint-disable MD033 MD041 -->\n<p align=\"center\">\n <a href=\"https://cli.nonebot.dev/\"><img src=\"https://cli.nonebot.dev/logo.png\" width=\"200\" height=\"200\" alt=\"nonebot\"></a>\n</p>\n\n<div align=\"center\">\n\n# NB CLI Plugin WebUI\n\n_\u2728 NoneBot2 \u547d\u4ee4\u884c\u5de5\u5177 \u524d\u7aef\u53ef\u89c6\u5316\u9875\u9762\uff08WebUI\uff09 \u63d2\u4ef6 \u2728_\n\n</div>\n\n<p align=\"center\">\n <a href=\"https://raw.githubusercontent.com/nonebot/nb-cli-plugin-webui/master/LICENSE\">\n <img src=\"https://img.shields.io/github/license/nonebot/cli-plugin-webui\" alt=\"license\">\n </a>\n <a href=\"https://pypi.python.org/pypi/nb-cli-plugin-webui\">\n <img src=\"https://img.shields.io/pypi/v/nb-cli-plugin-webui\" alt=\"pypi\">\n </a>\n <img src=\"https://img.shields.io/badge/python-3.8+-blue\" alt=\"python\">\n <a href=\"https://results.pre-commit.ci/latest/github/nonebot/nb-cli-plugin-webui/master\">\n <img src=\"https://results.pre-commit.ci/badge/github/nonebot/cli-plugin-webui/master.svg\" alt=\"pre-commit\" />\n </a>\n <br />\n <a href=\"https://jq.qq.com/?_wv=1027&k=5OFifDh\">\n <img src=\"https://img.shields.io/badge/QQ%E7%BE%A4-768887710-orange?style=flat-square\" alt=\"QQ Chat Group\">\n </a>\n <a href=\"https://qun.qq.com/qqweb/qunpro/share?_wv=3&_wwv=128&appChannel=share&inviteCode=7b4a3&appChannel=share&businessType=9&from=246610&biz=ka\">\n <img src=\"https://img.shields.io/badge/QQ%E9%A2%91%E9%81%93-NoneBot-5492ff?style=flat-square\" alt=\"QQ Channel\">\n </a>\n <a href=\"https://t.me/botuniverse\">\n <img src=\"https://img.shields.io/badge/telegram-botuniverse-blue?style=flat-square\" alt=\"Telegram Channel\">\n </a>\n <a href=\"https://discord.gg/VKtE6Gdc4h\">\n <img src=\"https://discordapp.com/api/guilds/847819937858584596/widget.png?style=shield\" alt=\"Discord Server\">\n </a>\n</p>\n\n## \u529f\u80fd\n\n- \u53ef\u89c6\u5316\u7684 nb cli \u64cd\u4f5c\n - \u521b\u5efa\u65b0\u7684 NoneBot \u5b9e\u4f8b\n - \u6dfb\u52a0\u5df2\u6709\u7684 NoneBot \u5b9e\u4f8b\n - \u62d3\u5c55\uff08\u63d2\u4ef6\u3001\u9002\u914d\u5668\u3001\u9a71\u52a8\u5668\uff09\u7ba1\u7406\uff08\u5b89\u88c5\u3001\u5378\u8f7d\uff09\n- \u53ef\u540c\u65f6\u7ba1\u7406\u591a\u4e2a NoneBot \u5b9e\u4f8b\n- \u4e3a\u542f\u52a8\u7684 NoneBot \u5b9e\u4f8b\u63d0\u4f9b\u72b6\u6001\u5c55\u793a\u3001\u6027\u80fd\u67e5\u8be2\n- \u53ef\u89c6\u5316\u7684 NoneBot \u5b9e\u4f8b\u914d\u7f6e\n\n## \u4f7f\u7528\n\n### \u5b89\u88c5\n\n**\u9700\u8981 [nb-cli](https://github.com/nonebot/nb-cli/)**\n\n\u4f7f\u7528 nb-cli \u5b89\u88c5\n\n```shell\nnb self install nb-cli-plugin-webui\n```\n\n\u4f7f\u7528 Docker \u8fd0\u884c\n\n```shell\ndocker pull nonebot/cil-plugin-webui:latest\n```\n\nDocker \u955c\u50cf\u53ef\u4ee5\u9009\u62e9\u4ee5\u4e0b\u7248\u672c:\n\n- `latest`, `latest-slim`: \u6700\u65b0\u7684\u7a33\u5b9a\u7248\u672c (Release)\n- `latest-${python \u7248\u672c}`, `latest-slim-${python \u7248\u672c}`: \u6307\u5b9a Python \u7248\u672c\u7684\u6700\u65b0\u7248\u672c\n- `sha-${commit sha:0:7}-${python \u7248\u672c}`, `sha-${commit sha:0:7}-${python \u7248\u672c}-slim`: \u6307\u5b9a commit \u7684\u7248\u672c\n- `${branch}-${python \u7248\u672c}`, `${branch}-${python \u7248\u672c}-slim`: \u6307\u5b9a\u5206\u652f\u7684\u6700\u65b0\u7248\u672c\n\n### \u547d\u4ee4\u884c\u4f7f\u7528\n\n```shell\nnb ui --help\n```\n\nDocker \u955c\u50cf\u4f7f\u7528\n\n```shell\ndocker run -it --rm -p 8080:8080 -v ./:/app nonebot/cli-plugin-webui:latest --help\n```\n\n\u53ef\u9009\u9644\u52a0 env \u53c2\u6570:\n\n- HOST: \u6307\u5b9a\u76d1\u542c\u5730\u5740\uff0c\u9ed8\u8ba4\u4e3a `0.0.0.0`\n- PORT: \u6307\u5b9a\u76d1\u542c\u7aef\u53e3\uff0c\u9ed8\u8ba4\u4e3a `8080`\n\n## \u5f00\u53d1\n\n\u5f85\u8865\u5145......\n\n## \u8865\u5145\n\nnb-cli WebUI \u76ee\u524d\u6b63\u5904\u4e8e\u5feb\u901f\u8fed\u4ee3\u4e2d\uff0c\u6b22\u8fce\u5404\u4f4d\u63d0\u4ea4\u5728\u4f7f\u7528\u8fc7\u7a0b\u4e2d\u53d1\u73b0\u7684 BUG \u548c\u5efa\u8bae\u3002\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "web ui support for nb-cli",
"version": "0.4.2",
"project_urls": {
"Documentation": "https://github.com/nonebot/cli-plugin-webui",
"Homepage": "https://github.com/nonebot/cli-plugin-webui",
"Repository": "https://github.com/nonebot/cli-plugin-webui"
},
"split_keywords": [
"nonebot",
" cli",
" web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "027bde4473f06eba6ba67e47c4205264fad2fb059d97f48fed429ea1f3badc66",
"md5": "53a739e64cf68521ecfbf2b148a6efd4",
"sha256": "085d1d8a9a84451c3127a47193f52894ee564e05449a190f728f2d06e5d80c7a"
},
"downloads": -1,
"filename": "nb_cli_plugin_webui-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "53a739e64cf68521ecfbf2b148a6efd4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 10060903,
"upload_time": "2024-04-12T11:31:27",
"upload_time_iso_8601": "2024-04-12T11:31:27.753252Z",
"url": "https://files.pythonhosted.org/packages/02/7b/de4473f06eba6ba67e47c4205264fad2fb059d97f48fed429ea1f3badc66/nb_cli_plugin_webui-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "505c26b8440e4100231aadc727c8978423d69ab1867bc0f788f4fe2d95e3a141",
"md5": "6787802ca12965b3b27808c715f1e008",
"sha256": "4d4c84063fee972e817f8df2dbaf382ad3e97ab1035b0a4f893366c92a2b255b"
},
"downloads": -1,
"filename": "nb_cli_plugin_webui-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "6787802ca12965b3b27808c715f1e008",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.1",
"size": 10036178,
"upload_time": "2024-04-12T11:31:31",
"upload_time_iso_8601": "2024-04-12T11:31:31.058240Z",
"url": "https://files.pythonhosted.org/packages/50/5c/26b8440e4100231aadc727c8978423d69ab1867bc0f788f4fe2d95e3a141/nb_cli_plugin_webui-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 11:31:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nonebot",
"github_project": "cli-plugin-webui",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nb-cli-plugin-webui"
}
JSON
