mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-10-29 20:05:25 +08:00
docs: update for plugin version
This commit is contained in:
Junyan Qin
@@ -1,28 +1,5 @@
|
||||
# Command Details
|
||||
# Command
|
||||
|
||||
> Parameters in `<>` are required, do not include `<>` when using
|
||||
> Parameters in `[]` are optional, do not include `[]` when using
|
||||
> Here we only list the commands briefly, for detailed usage please use the `!cmd` command
|
||||
LangBot will regard messages starting with `!` as commands. Official provides [`EssentialCommands` plugin](https://space.langbot.app/market?author=langbot-team&plugin=EssentialCommands), which includes commonly used commands.
|
||||
|
||||
## Command List
|
||||
|
||||
Available to any object
|
||||
|
||||
```
|
||||
!help Display custom help information (can be changed in the configuration file)
|
||||
!cmd [command name] Display command list or detailed information for a specific command
|
||||
!list [page number] List the history sessions for this object
|
||||
!del <number> Delete the specified history record, you can view the number with !list
|
||||
!del all Delete all history records for this session object
|
||||
!last Switch to the previous session
|
||||
!next Switch to the next session
|
||||
!reset Reset the current session
|
||||
!prompt View all records of the current session
|
||||
!version Check the current version and check for updates
|
||||
!resend Rollback the previous request
|
||||
!plugin For usage, please see the `Management` section of the plugin introduction page
|
||||
```
|
||||
|
||||
## Command Permission Control
|
||||
|
||||
You can [edit the system environment settings](/en/deploy/settings.md) to set permissions for command nodes. When a command is initiated, if the user's permission level (administrator is `2`, regular user is `1`) is greater than or equal to the command node's permission level, the command can be successfully executed.
|
||||
You can also develop your own command plugin, please refer to [Command Plugin Development](/en/plugin/dev/components/command.md).
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Using Docker (or one-click deployment based on Docker)
|
||||
|
||||
Please execute in the `docker-compose.yaml` directory:
|
||||
Please execute in the `docker/docker-compose.yaml` directory:
|
||||
|
||||
```bash
|
||||
docker compose up --force-recreate --pull always -d
|
||||
@@ -10,6 +10,10 @@ docker compose up --force-recreate --pull always -d
|
||||
|
||||
This command will pull the latest LangBot image and rebuild the container.
|
||||
|
||||
:::info
|
||||
4.3.0 version changed the content and location of the `docker-compose.yaml` file, please [redploy according to the documentation](/en/deploy/langbot/docker).
|
||||
:::
|
||||
|
||||
## Manual Deployment
|
||||
|
||||
Download the latest release's `langbot-<version>-all.zip` from the Assets section on the [Releases](https://github.com/langbot-app/LangBot/releases) page, extract it to the original deployment directory, and restart.
|
||||
|
||||
@@ -1,28 +1,5 @@
|
||||
# 命令详解
|
||||
# 命令
|
||||
|
||||
> `<>` 中的为必填参数，使用时请不要包含`<>`
|
||||
> `[]` 中的为可选参数，使用时请不要包含`[]`
|
||||
> 这里只简单列举命令，具体使用方式请使用 `!cmd` 命令查看
|
||||
LangBot 将以 `!` 开头的消息视为命令。官方提供了 [`EssentialCommands` 插件](https://space.langbot.app/market?author=langbot-team&plugin=EssentialCommands)，包含了常用的命令。
|
||||
|
||||
## 命令列表
|
||||
|
||||
任何对象可使用
|
||||
|
||||
```
|
||||
!help 显示自定义的帮助信息（可在配置文件中更改）
|
||||
!cmd [命令名称] 显示命令列表或指定命令的详细信息
|
||||
!list [页数] 列出本对象的历史会话列表
|
||||
!del <序号> 删除指定的历史记录，可以通过 !list 查看序号
|
||||
!del all 删除本会话对象的所有历史记录
|
||||
!last 切换到前一次会话
|
||||
!next 切换到后一次会话
|
||||
!reset 重置当前会话
|
||||
!prompt 查看当前会话的所有记录
|
||||
!version 查看当前版本并检查更新
|
||||
!resend 回滚前一次请求
|
||||
!plugin 用法请查看插件介绍页的`管理`章节
|
||||
```
|
||||
|
||||
## 命令权限控制
|
||||
|
||||
您可以[编辑系统环境设置](/zh/deploy/settings.md)来设置命令节点的权限，当命令被发起时，若用户的权限级别（管理员为`2`，普通用户为`1`）大于等于命令节点的权限级别，命令即可被成功执行。
|
||||
您也可以开发自己的命令插件，请参考 [命令插件开发](/zh/plugin/dev/components/command.md)。
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## 使用 Docker（或基于 Docker 的一键部署）
|
||||
|
||||
请在 `docker-compose.yaml` 目录下执行：
|
||||
请在 `docker/docker-compose.yaml` 目录下执行：
|
||||
|
||||
```bash
|
||||
docker compose up --force-recreate --pull always -d
|
||||
@@ -10,6 +10,10 @@ docker compose up --force-recreate --pull always -d
|
||||
|
||||
此命令将拉取最新的 LangBot 镜像并重建容器。
|
||||
|
||||
:::info
|
||||
4.3.0 版本更改了 `docker/docker-compose.yaml` 文件的内容和位置，请[根据文档重新部署](/zh/deploy/langbot/docker)。
|
||||
:::
|
||||
|
||||
## 手动部署
|
||||
|
||||
从 [Releases](https://github.com/langbot-app/LangBot/releases) 页面下载最新发行版的 Assets 下的 `langbot-<version>-all.zip`，解压到原来部署到目录重启即可。
|
||||
Reference in New Issue
Block a user