From 4c0b8537c51e52afff33872055df985b1fc45027 Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Sun, 11 May 2025 20:39:40 +0800 Subject: [PATCH] doc: add command doc --- docs/.vitepress/config.mts | 4 ++++ docs/zh/deploy/command.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 docs/zh/deploy/command.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index bb0a55b31..bf6695eeb 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -135,6 +135,10 @@ export default defineConfig({ text: "系统环境设置", link: "/zh/deploy/settings", }, + { + text: "对话命令", + link: "/zh/deploy/command", + }, { text: "更新 LangBot", link: "/zh/deploy/update", diff --git a/docs/zh/deploy/command.md b/docs/zh/deploy/command.md new file mode 100644 index 000000000..004b465a1 --- /dev/null +++ b/docs/zh/deploy/command.md @@ -0,0 +1,29 @@ +# 命令详解 + +> `<>` 中的为必填参数,使用时请不要包含`<>` +> `[]` 中的为可选参数,使用时请不要包含`[]` +> 这里只简单列举命令,具体使用方式请使用 `!cmd` 命令查看 + +## 命令列表 + +任何对象可使用 + +``` +!help 显示自定义的帮助信息(可在配置文件中更改) +!cmd [命令名称] 显示命令列表或指定命令的详细信息 +!list [页数] 列出本对象的历史会话列表 +!del <序号> 删除指定的历史记录,可以通过 !list 查看序号 +!del all 删除本会话对象的所有历史记录 +!last 切换到前一次会话 +!next 切换到后一次会话 +!reset 重置当前会话 +!prompt 查看当前会话的所有记录 +!version 查看当前版本并检查更新 +!resend 回滚前一次请求 +!plugin 用法请查看插件介绍页的`管理`章节 +!default 查看可用的情景预设值 +``` + +## 命令权限控制 + +您可以[编辑系统环境设置](/zh/deploy/settings.md)来设置命令节点的权限,当命令被发起时,若用户的权限级别(管理员为`2`,普通用户为`1`)大于等于命令节点的权限级别,命令即可被成功执行。 \ No newline at end of file