Koishi

Koishi 是一个在 Node.js 环境下运行，基于 CoolQ 和 CQHTTP 的 QQ 机器人框架。

这个项目的名字和图标来源于东方 Project 中的角色古明地恋（Komeiji Koishi）。

特性

Koishi 高度配置化的 CLI 命令可以让你无需写代码就搭建属于你的机器人。与此同时，CLI 还配备了丰富和人性化的提示，进一步提高调试体验。

Koishi 的 API 包括下面几个部分：

每一个部分都经过了精心的编写，可以让你轻松实现任何需求。

Koishi 在编写时，也同样编写了大量的官方插件作为补充。它们有些 Koishi 的基础功能，有些则为 Koishi 的使用提供了许多便利。更重要的是，这数十个插件都可以作为 Koishi 插件开发的极好示范。

Koishi 原生地支持了多机器人开发，同时为这些机器人之间互通数据、共用服务器、保证数据安全提供了原生的解决方案，这有助于在保持高性能的同时，将腾讯风控造成的影响降低到最小。

Koishi 在开发时借助了下面的工具：

这保证了其代码的正确性和可读性。

特性	koishi 1.3.0	cqhttp 1.2.0	cq-websocket 2.0.2	lemon-bot 0.6.0	@ionjs/core 0.6.5
依赖数量	10 / 21	62	37	65	73
安装体积 (MB)	0.78 / 2.14	1.86	2.82	2.56	2.32
HTTP	✔️	✔️	❌	✔️	✔️
WebSocket	✔️	❌	✔️	❌	❌
反向 WebSocket	❌	❌	❌	❌	❌
监听器	✔️	✔️	✔️	❌	✔️
上下文	✔️	❌	❌	✔️	✔️
中间件	✔️	❌	❌	❌	✔️
命令行	✔️	❌	❌	❌	❌
指令	✔️	❌	❌	✔️	❌

注：依赖数量如果表示为 X/Y，则 X 表示核心库依赖数量，Y 表示命令行工具依赖数量。

# 进入文件夹
cd my-bot

# 安装 Koishi
npm i koishi -g

# 初始化配置文件
koishi init

# 运行你的 Bot
koishi run

现在可以对你的机器人说话了：

> echo hello world
< hello world

注意: Koishi 要求您的 Node.js 的版本不小于 10，CQHTTP 的版本不小于 3.0。过低的 CQHTTP 版本将不会支持 Koishi 的某些功能。因此，我们建议您保持较新的 CQHTTP 版本以确保所有功能可用。

完整的文档在这里。

此外，您可以参考我们的：模板仓库。