Skip to content

A-kirami/KiramiCLI

Repository files navigation

KiramiCLI

✨ KiramiBot 命令行工具 ✨

license pypi python black pyright ruff
pre-commit pyright ruff

文档   |   安装   |   KiramiBot 文档

功能

  • 创建新的 KiramiBot 项目
  • 启动 KiramiBot
  • 管理插件
    • 创建新的插件
    • 搜索/安装/更新/卸载在官方商店上发布的插件
  • 管理适配器
    • 创建新的适配器
    • 搜索/安装/更新/卸载在官方商店上发布的适配器
  • 管理驱动器
    • 搜索/安装/更新/卸载在官方商店上发布的驱动器
  • 从 NoneBot2 迁移到 KiramiBot
  • 支持 CLI 插件和运行脚本

安装

推荐安装方式

Linux, macOS, Windows (WSL)

curl -sSL https://install.kiramibot.dev | python3 -

Windows (Powershell)

(Invoke-WebRequest -Uri https://install.kiramibot.dev -UseBasicParsing).Content | py -

其他安装方式

pipx

pipx install kirami-cli

pip

pip install --user kirami-cli

使用

完整使用说明请参考 文档

命令行使用

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> 运行脚本

交互式使用

kirami

开发

翻译

生成模板

pdm run extract

初始化语言翻译文件或者更新现有语言翻译文件

pdm run init en_US

更新语言翻译文件

pdm run update

编译语言翻译文件

pdm run compile

许可证

本项目原始代码来自 NB CLI,以相同的许可证发布。