1
0
forked from bot/app
LiteyukiBot/docs/usage/basic_command.md

108 lines
3.3 KiB
Markdown
Raw Normal View History

2024-03-28 12:05:03 +08:00
---
title: 基础命令
2024-03-31 10:59:17 +08:00
icon: comment
2024-03-28 12:05:03 +08:00
order: 1
category: 使用手册
---
## 基础插件
2024-03-28 12:05:03 +08:00
### **轻雪 `liteyuki`**
2024-03-28 12:05:03 +08:00
```shell
2024-04-10 07:38:13 +08:00
# 仅超级用户
reload-liteyuki # 重载轻雪
update-liteyuki # 更新轻雪
liteecho # 查看当前bot
2024-04-10 10:01:41 +08:00
status # 查看统计信息和状态
config set <key> value # 添加配置项,若存在则会覆盖,输入值会被执行以转换为正确的类型,"10"和10是不一样的
config get [key] # 查询配置项不带key返回配置项列表推荐私聊使用
switch-image-mode # 在普通图片和Markdown大图之间切换该功能需要commit:505468b及以后的Lagrange.OneBot
2024-04-21 14:15:12 +08:00
/api api_name [args] # 调用机器人API例如/api get_group_member_list group_id=1234567空格用%20
2024-06-02 02:23:00 +08:00
/function function_name [args] [kwargs] # 调用机器人函数,例如/function send_group_msg group_id=1234567 message=hello
# 仅超级用户,群聊仅群主、管理员、超级用户可用
group enable/disable [group_id] # 在群聊启用/停用机器人group_id仅超级用户可用
2024-04-10 07:38:13 +08:00
# 所有人可用
liteyuki-docs # 查看轻雪文档
2024-03-28 12:05:03 +08:00
```
命令别名
2024-03-28 12:05:03 +08:00
```shell
2024-04-10 10:01:41 +08:00
status 状态,
reload-liteyuki 重启轻雪,
update-liteyuki 更新轻雪,
reload-resources 重载资源,
config 配置 | set 设置 | get 查询,
switch-image-mode 切换图片模式,
liteyuki-docs 轻雪文档
group 群聊 | enable 启用 | disable 停用
```
2024-05-12 03:04:26 +08:00
***
### **插件/包管理器 `liteyuki_pacman`**
- 插件管理
```shell
# 仅超级用户
npm update # 更新插件商店索引
npm install <plugin_name> # 安装插件
npm uninstall <plugin_name> # 卸载插件
npm search <keywords...> # 通过关键词搜索插件
npm enable-global/disable-global <plugin_name> # 全局启用/停用插件
# 群聊仅群主、管理员、超级用户可用,私聊所有人可用
npm enable/disable <plugin_name> [--group <group_id>] # 当前会话启用/停用插件
npm list [page] [num] # 列出所有插件 page为页数num为每页显示数量
2024-04-19 00:45:57 +08:00
# 所有人
help <plugin_name> # 查看插件帮助
```
- 资源包管理
```shell
# 仅超级用户
rpm list [page] [num] # 列出所有资源包 page为页数num为每页显示数量
rpm load <pack_name> # 加载资源包
rpm unload <pack_name> # 卸载资源包
rpm change <pack_name> # 修改优先级
rpm reload # 重载所有资源包
```
命令别名
```shell
npm 插件管理 | update 更新 | install 安装 | uninstall 卸载 | search 搜索
enable 启用 | disable 停用 | enable-global 全局启用 | disable-global 全局停用 | --group -g
rpm 资源包 | load 加载 | unload 卸载 | change 更改 | reload 重载 | list 列表
2024-04-19 00:45:57 +08:00
help 帮助
2024-03-28 12:05:03 +08:00
```
2024-04-10 23:06:55 +08:00
> [!warning]
> 受限于NoneBot2钩子函数的依赖注入参数插件停用只能阻断传入响应对于主动推送的插件不生效请阅读插件主页的说明。
2024-03-28 12:05:03 +08:00
2024-05-12 03:04:26 +08:00
***
### **用户管理`liteyuki_user`**
2024-03-28 12:05:03 +08:00
```shell
2024-04-10 07:38:13 +08:00
# 所有人可用
2024-03-28 12:05:03 +08:00
profile # 查看用户信息菜单
profile set <key> [value] # 设置用户信息或打开属性设置菜单
profile get <key> # 获取用户信息
```
命令别名
```shell
profile 个人信息 | set 设置 | get 查询
2024-03-28 12:05:03 +08:00
```
2024-04-10 23:06:55 +08:00
> [!tip]
> **参数**`<param>`为必填参数,`[option]`为可选参数。
2024-04-19 00:45:57 +08:00
>
2024-04-10 23:06:55 +08:00
> **命令别名**:配置了命令别名的命令可以使用别名代替原命令,例如`npm install ~`可以使用`插件 安装 ~`代替。