<div align="center">
# KiramiCLI
✨ KiramiBot 命令行工具 ✨
</div>
<p align="center">
<a href="https://raw.githubusercontent.com/A-kirami/KiramiCLI/main/LICENSE">
<img src="https://img.shields.io/github/license/A-kirami/KiramiCLI" alt="license">
</a>
<a href="https://pypi.python.org/pypi/kirami-cli">
<img src="https://img.shields.io/pypi/v/kirami-cli" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.10+-blue?logo=python&logoColor=edb641" alt="python">
<a href="https://github.com/psf/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=edb641" alt="black">
</a>
<a href="https://github.com/Microsoft/pyright">
<img src="https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641" alt="pyright">
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="ruff">
</a>
<br />
<a href="https://results.pre-commit.ci/latest/github/A-kirami/KiramiCLI/main">
<img src="https://results.pre-commit.ci/badge/github/A-kirami/KiramiCLI/main.svg" alt="pre-commit" />
</a>
<a href="https://github.com/A-kirami/KiramiCLI/actions/workflows/pyright.yml">
<img src="https://github.com/A-kirami/KiramiCLI/actions/workflows/pyright.yml/badge.svg?branch=main&event=push" alt="pyright">
</a>
<a href="https://github.com/A-kirami/KiramiCLI/actions/workflows/ruff.yml">
<img src="https://github.com/A-kirami/KiramiCLI/actions/workflows/ruff.yml/badge.svg?branch=main&event=push" alt="ruff">
</a>
</p>
<p align="center">
<a href="https://cli.kiramibot.dev/" target="__blank">文档</a>
|
<a href="https://cli.kiramibot.dev/docs/guide/installation" target="__blank">安装</a>
|
<a href="https://kiramibot.dev/" target="__blank">KiramiBot 文档</a>
</p>
## 功能
- 创建新的 KiramiBot 项目
- 启动 KiramiBot
- 管理插件
- 创建新的插件
- 搜索/安装/更新/卸载在官方商店上发布的插件
- 管理适配器
- 创建新的适配器
- 搜索/安装/更新/卸载在官方商店上发布的适配器
- 管理驱动器
- 搜索/安装/更新/卸载在官方商店上发布的驱动器
- 从 NoneBot2 迁移到 KiramiBot
- 支持 CLI 插件和运行脚本
## 使用
完整使用文档请参考 [文档](https://cli.kiramibot.dev/)。
### 安装
使用 pipx 安装
```shell
pipx install kirami-cli
```
### 命令行使用
```shell
kirami --help
```
> **Warning**
>
> 如果找不到 `kirami` 命令，请尝试 `pipx ensurepath` 来添加路径到环境变量
- `kirami create (init)` 创建新的 KiramiBot 项目
- `kirami run` 在当前目录启动 KiramiBot
- `kirami driver` 管理驱动器
- `kirami plugin` 管理插件
- `kirami adapter` 管理适配器
- `kirami self` 管理 CLI 内部环境
- `kirami migrate` 从 NoneBot2 迁移到 KiramiBot
- `kirami <script>` 运行脚本
### 交互式使用
```shell
kirami
```
## 开发
### 翻译
生成模板
```shell
pdm run extract
```
初始化语言翻译文件或者更新现有语言翻译文件
```shell
pdm run init en_US
```
更新语言翻译文件
```shell
pdm run update
```
编译语言翻译文件
```shell
pdm run compile
```
## 许可证
本项目原始代码来自 [NB CLI](https://github.com/nonebot/nb-cli)，以相同的许可证发布。
Raw data
{
"_id": null,
"home_page": "https://cli.kiramibot.dev/",
"name": "kirami-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "",
"keywords": "kirami bot chatbot onebot",
"author": "",
"author_email": "Akirami <akiramiaya@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/8c/b2/2a39de9ddacab3f04621d841915dbadedd2ce6b9166602daa6987eaf2277/kirami_cli-0.1.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# KiramiCLI\n\n\u2728 KiramiBot \u547d\u4ee4\u884c\u5de5\u5177 \u2728\n\n</div>\n\n<p align=\"center\">\n <a href=\"https://raw.githubusercontent.com/A-kirami/KiramiCLI/main/LICENSE\">\n <img src=\"https://img.shields.io/github/license/A-kirami/KiramiCLI\" alt=\"license\">\n </a>\n <a href=\"https://pypi.python.org/pypi/kirami-cli\">\n <img src=\"https://img.shields.io/pypi/v/kirami-cli\" alt=\"pypi\">\n </a>\n <img src=\"https://img.shields.io/badge/python-3.10+-blue?logo=python&logoColor=edb641\" alt=\"python\">\n <a href=\"https://github.com/psf/black\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=edb641\" alt=\"black\">\n </a>\n <a href=\"https://github.com/Microsoft/pyright\">\n <img src=\"https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641\" alt=\"pyright\">\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\" alt=\"ruff\">\n </a>\n <br />\n <a href=\"https://results.pre-commit.ci/latest/github/A-kirami/KiramiCLI/main\">\n <img src=\"https://results.pre-commit.ci/badge/github/A-kirami/KiramiCLI/main.svg\" alt=\"pre-commit\" />\n </a>\n <a href=\"https://github.com/A-kirami/KiramiCLI/actions/workflows/pyright.yml\">\n <img src=\"https://github.com/A-kirami/KiramiCLI/actions/workflows/pyright.yml/badge.svg?branch=main&event=push\" alt=\"pyright\">\n </a>\n <a href=\"https://github.com/A-kirami/KiramiCLI/actions/workflows/ruff.yml\">\n <img src=\"https://github.com/A-kirami/KiramiCLI/actions/workflows/ruff.yml/badge.svg?branch=main&event=push\" alt=\"ruff\">\n </a>\n</p>\n\n<p align=\"center\">\n <a href=\"https://cli.kiramibot.dev/\" target=\"__blank\">\u6587\u6863</a>\n | \n <a href=\"https://cli.kiramibot.dev/docs/guide/installation\" target=\"__blank\">\u5b89\u88c5</a>\n | \n <a href=\"https://kiramibot.dev/\" target=\"__blank\">KiramiBot \u6587\u6863</a>\n</p>\n\n## \u529f\u80fd\n\n- \u521b\u5efa\u65b0\u7684 KiramiBot \u9879\u76ee\n- \u542f\u52a8 KiramiBot\n- \u7ba1\u7406\u63d2\u4ef6\n - \u521b\u5efa\u65b0\u7684\u63d2\u4ef6\n - \u641c\u7d22/\u5b89\u88c5/\u66f4\u65b0/\u5378\u8f7d\u5728\u5b98\u65b9\u5546\u5e97\u4e0a\u53d1\u5e03\u7684\u63d2\u4ef6\n- \u7ba1\u7406\u9002\u914d\u5668\n - \u521b\u5efa\u65b0\u7684\u9002\u914d\u5668\n - \u641c\u7d22/\u5b89\u88c5/\u66f4\u65b0/\u5378\u8f7d\u5728\u5b98\u65b9\u5546\u5e97\u4e0a\u53d1\u5e03\u7684\u9002\u914d\u5668\n- \u7ba1\u7406\u9a71\u52a8\u5668\n - \u641c\u7d22/\u5b89\u88c5/\u66f4\u65b0/\u5378\u8f7d\u5728\u5b98\u65b9\u5546\u5e97\u4e0a\u53d1\u5e03\u7684\u9a71\u52a8\u5668\n- \u4ece NoneBot2 \u8fc1\u79fb\u5230 KiramiBot\n- \u652f\u6301 CLI \u63d2\u4ef6\u548c\u8fd0\u884c\u811a\u672c\n\n## \u4f7f\u7528\n\n\u5b8c\u6574\u4f7f\u7528\u6587\u6863\u8bf7\u53c2\u8003 [\u6587\u6863](https://cli.kiramibot.dev/)\u3002\n\n### \u5b89\u88c5\n\n\u4f7f\u7528 pipx \u5b89\u88c5\n\n```shell\npipx install kirami-cli\n```\n\n### \u547d\u4ee4\u884c\u4f7f\u7528\n\n```shell\nkirami --help\n```\n\n> **Warning**\n>\n> \u5982\u679c\u627e\u4e0d\u5230 `kirami` \u547d\u4ee4\uff0c\u8bf7\u5c1d\u8bd5 `pipx ensurepath` \u6765\u6dfb\u52a0\u8def\u5f84\u5230\u73af\u5883\u53d8\u91cf\n\n- `kirami create (init)` \u521b\u5efa\u65b0\u7684 KiramiBot \u9879\u76ee\n- `kirami run` \u5728\u5f53\u524d\u76ee\u5f55\u542f\u52a8 KiramiBot\n- `kirami driver` \u7ba1\u7406\u9a71\u52a8\u5668\n- `kirami plugin` \u7ba1\u7406\u63d2\u4ef6\n- `kirami adapter` \u7ba1\u7406\u9002\u914d\u5668\n- `kirami self` \u7ba1\u7406 CLI \u5185\u90e8\u73af\u5883\n- `kirami migrate` \u4ece NoneBot2 \u8fc1\u79fb\u5230 KiramiBot\n- `kirami <script>` \u8fd0\u884c\u811a\u672c\n\n### \u4ea4\u4e92\u5f0f\u4f7f\u7528\n\n```shell\nkirami\n```\n\n## \u5f00\u53d1\n\n### \u7ffb\u8bd1\n\n\u751f\u6210\u6a21\u677f\n\n```shell\npdm run extract\n```\n\n\u521d\u59cb\u5316\u8bed\u8a00\u7ffb\u8bd1\u6587\u4ef6\u6216\u8005\u66f4\u65b0\u73b0\u6709\u8bed\u8a00\u7ffb\u8bd1\u6587\u4ef6\n\n```shell\npdm run init en_US\n```\n\n\u66f4\u65b0\u8bed\u8a00\u7ffb\u8bd1\u6587\u4ef6\n\n```shell\npdm run update\n```\n\n\u7f16\u8bd1\u8bed\u8a00\u7ffb\u8bd1\u6587\u4ef6\n\n```shell\npdm run compile\n```\n\n## \u8bb8\u53ef\u8bc1\n\n\u672c\u9879\u76ee\u539f\u59cb\u4ee3\u7801\u6765\u81ea [NB CLI](https://github.com/nonebot/nb-cli)\uff0c\u4ee5\u76f8\u540c\u7684\u8bb8\u53ef\u8bc1\u53d1\u5e03\u3002\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI for KiramiBot",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://cli.kiramibot.dev/",
"Repository": "https://github.com/A-kirami/KiramiCLI"
},
"split_keywords": [
"kirami",
"bot",
"chatbot",
"onebot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ebb99dd334a4b4568427c5503b045e71e3593ceb722e6962a969345f7078b4a",
"md5": "8d76de16d7a06d788647dfa231178f47",
"sha256": "c7e4da18f06c56cced56895ba83f0f9a673222ba3ea39e79de0ccb575ce3d611"
},
"downloads": -1,
"filename": "kirami_cli-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d76de16d7a06d788647dfa231178f47",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 55930,
"upload_time": "2023-09-14T21:28:15",
"upload_time_iso_8601": "2023-09-14T21:28:15.163462Z",
"url": "https://files.pythonhosted.org/packages/0e/bb/99dd334a4b4568427c5503b045e71e3593ceb722e6962a969345f7078b4a/kirami_cli-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8cb22a39de9ddacab3f04621d841915dbadedd2ce6b9166602daa6987eaf2277",
"md5": "bd06393516ed939bb235161dda110c1f",
"sha256": "3c8ee82f1dd8f16837f18aca38dacf9f0d4975511c9305e464d7d9cf143882b8"
},
"downloads": -1,
"filename": "kirami_cli-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "bd06393516ed939bb235161dda110c1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 34049,
"upload_time": "2023-09-14T21:28:16",
"upload_time_iso_8601": "2023-09-14T21:28:16.799057Z",
"url": "https://files.pythonhosted.org/packages/8c/b2/2a39de9ddacab3f04621d841915dbadedd2ce6b9166602daa6987eaf2277/kirami_cli-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-14 21:28:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "A-kirami",
"github_project": "KiramiCLI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kirami-cli"
}
JSON
