refactor: 每个插件独立文件夹,添加使用教程

- dglab_ws/ 插件代码 + README.md 使用教程
- 根目录 README.md 更新为仓库总览与开发指南
This commit is contained in:
xiaoli-cli bot committed 2026-04-30 02:31:06 +08:00
1 parent 4065b98851
commit 742b9e4b41
3 files changed
+199 -16

No files matched your search

+36 -16
View File
@@ -4,45 +4,65 @@
## 插件列表
| 插件 | 说明 |
|------|------|
| [dglab_ws](./dglab_ws.py) | DG-Lab 郊狼 3.0 WebSocket 控制插件 |
| 插件 | 说明 | 依赖 |
|------|------|------|
| [dglab_ws](./dglab_ws/) | DG-Lab 郊狼 3.0 WebSocket 控制 | websocket-client, qrcode(可选) |
## 安装方式
将插件 `.py` 文件复制到 xiaoli-cli 项目的 `plugins/` 目录下,然后在 `plugins_config.py` 中启用:
1. 将插件文件夹中的 `.py` 文件复制到 xiaoli-cli 的 `plugins/` 目录
2. 在 `plugins_config.py` 中启用对应插件
```python
ENABLE_DGLAB_WS = True # 启用 DG-Lab 插件
```bash
# 示例:安装 dglab_ws 插件
cp dglab_ws/dglab_ws.py /path/to/xiaoli-cli/plugins/
```
## 插件开发
```python
# plugins_config.py
ENABLE_DGLAB_WS = True
```
每个插件是一个独立的 `.py` 文件,需包含 `Liugin` 类(兼容 `Plugin` 类名):
## 插件目录结构
每个插件一个文件夹,包含:
```
插件名/
├── 插件名.py # 插件代码
└── README.md # 使用教程
```
## 开发插件
插件是一个独立 `.py` 文件,需包含 `Liugin` 类(兼容 `Plugin`):
```python
class Liugin:
def get_tool_info(self):
"""返回插件元信息"""
return {
"name": "插件名",
"description": "插件描述",
"keywords": ["关键词1", "关键词2"],
"description": "一句话描述",
"keywords": ["关键词"],
"usage": "使用说明"
}
def handle(self, args):
return "处理结果"
"""处理命令,返回结果字符串"""
return "结果"
# 可选:注册CLI命令
def set_cli(self, cli):
self.cli = cli
"""可选:注册CLI斜杠命令"""
pass
# 可选:MCP支持
def get_mcp_definition(self):
return {...}
"""可选:MCP工具定义"""
return {}
def convert_mcp_args(self, arguments):
return "转换后的参数"
"""可选:MCP参数转CLI参数"""
return ""
```
## License