OpenDesk CLI 使用手册

OpenDesk CLI 是 OpenDesk 的命令行版本，提供了基于终端的文本用户界面（TUI），让您可以在不启动完整桌面应用的情况下使用 OpenDesk 的强大功能。它支持与 AI 助手的自然对话、任务管理、文件操作等功能。

快速开始

如果你还没有安装 OpenDesk，请先阅读快速开始指南，了解如何安装、配置和首次运行。

💡 提示：大部分配置可以通过自然语言对话完成，无需手动编辑配置文件。遇到问题时，直接告诉 AI “帮我配置 xxx” 即可。

30 秒上手

# 在当前目录启动 OpenDesk
opendesk

# 指定工作空间
opendesk /path/to/your/project

# 使用特定模型
opendesk --model gpt-4

启动后，你会看到交互式 TUI 界面，直接输入自然语言即可开始对话。

两种使用模式

模式	命令	适用场景	特点
交互模式	`opendesk`	日常开发、调试、学习	实时对话、可视化输出
单次执行	`opendesk -c "任务"`	快速任务、脚本自动化	执行后自动退出

第一次对话

启动后，试试这些命令：

# 让 AI 总结今天的新闻
搜索并整理今天 AI 领域的最新动态

# 让 AI 帮你写代码
帮我写一个 Python 脚本读取 CSV 文件

详细功能指南

下面按 CLI 的主要使用场景展开说明。

1. 命令行参数详解

基本命令格式

opendesk [workspace] [options]

位置参数

参数	说明	默认值	示例
`workspace`	工作空间目录路径	当前目录 `.`	`opendesk /path/to/project`

核心选项速查

模型与执行

选项	说明	示例
`--model <alias>`	指定使用的模型别名	`opendesk --model gpt-4`
`-c, --command <cmd>`	执行命令后退出（单次模式）	`opendesk -c "写 README"`
`--headless`	无头模式（需配合 `-c`）	`opendesk --headless -c "分析代码"`

输出与导出

选项	说明	示例
`--export-html <path>`	导出为 HTML	`opendesk -c "任务" --export-html result.html`
`--export-json <path>`	导出为 JSON	`opendesk -c "任务" --export-json result.json`
`--dump-log <path>`	日志转储到文件	`opendesk -c "任务" --dump-log debug.log`

子命令一览

插件管理

opendesk plugins install <spec>     # 安装插件
opendesk plugins uninstall <id>     # 卸载插件
opendesk plugins list               # 列出已安装插件
opendesk plugins enable <id>        # 启用插件
opendesk plugins disable <id>       # 禁用插件
opendesk plugins reset-openclaw-shim  # 重置 openclaw 兼容层（调试命令）

工具管理

opendesk tools list                 # 列出所有工具
opendesk tools info <name>          # 查看工具详情
opendesk tools call <name> [args]   # 直接调用工具

技能管理

opendesk skill install <source>       # 安装技能
opendesk skill uninstall <skillName>  # 卸载技能
opendesk skill list                   # 列出已安装的技能

消息渠道

opendesk channels list              # 列出已安装的消息插件
opendesk channels info              # 加载并检查所有已启用的消息插件

实战示例

场景 1：日常开发

# 启动交互模式，开始对话
opendesk

# 执行单条命令后退出
opendesk -c "总结今天的工作"

# 使用特定模型
opendesk --model claude-3-opus

场景 2：自动化脚本

# CI/CD 中使用：代码审查并导出结果
opendesk -c "代码审查" --export-json review.json

2. 交互式 TUI 界面

界面布局

┌──────────────────────────────────────────────────────────────┐
│  🎯 OpenDesk Banner (工作空间路径)                             │
├──────────────────────────────────────────────────────────────┤
│  📋 任务视图区域                                               │
│     - 消息显示                                                │
│     - AI 回复                                                 │
├──────────────────────────────────────────────────────────────┤
│  📝 待办事项列表                                               │
├──────────────────────────────────────────────────────────────┤
│  🔍 输入区域                                                   │
├──────────────────────────────────────────────────────────────┤
│  📂 日志面板（可选）                                            │
├──────────────────────────────────────────────────────────────┤
│  📊 状态栏: 模型 | Token数 | 运行时间                            │
├──────────────────────────────────────────────────────────────┤
│  📡 仪表盘栏: 渠道状态 | 通知数 | ...                            │
└──────────────────────────────────────────────────────────────┘

状态栏信息

状态栏实时显示关键信息：

** 模型名称** — 当前使用的模型
** 上下文长度** — 模型支持的最大 Token 数
** Token 统计** — 当前会话消耗的 Token（输入/输出）
** 运行时间** — 当前任务的执行时长

输入区域功能

功能	说明
自然语言输入	直接输入问题或任务描述
斜杠命令	以 `/` 开头的特殊命令（如 `/help`）
消息队列	连续输入多条消息会自动排队依次执行
自动补全	输入时自动提示命令、文件路径、参数
配置口令导入	粘贴配置口令字符串，自动应用对应配置

3. 斜杠命令详解

在输入框中输入 / 可查看所有可用命令。

常用命令速查表

命令	说明	快捷键	最常用
`/new [消息]`	新建任务	`Ctrl+N`	⭐
`/switch`	切换任务	`Ctrl+L`	⭐
`/help`	显示帮助	-	⭐
`/exit`	退出程序	-	⭐
`/stop`	停止当前任务	-	⭐
`/clear`	清除历史	-
`/compact`	压缩上下文	-	⭐

任务管理命令

命令	说明	使用场景
`/rename <新名称>`	重命名任务	标记重要任务
`/fork`	复制会话创建新会话	从某个点重新探索
`/undo [N]`	回退最近 N 条消息	撤销错误的输入
`/redo [N]`	恢复回退的消息	恢复之前的内容
`/bookmark add`	添加书签	标记重要任务
`/bookmark list`	列出书签	查看标记的任务
`/cancel`	清空消息队列	取消等待中的消息

导入导出命令

命令	说明	示例
`/export html [文件名]`	导出为 HTML	`/export html conversation.html`
`/export json <文件名>`	导出为 JSON	`/export json data.json`
`/export skill <技能名> <路径.zip>`	导出技能为 zip	`/export skill coding-tutor skill.zip`
`/import task [文件名]`	从 JSON 导入任务	`/import task saved-task.json`

系统配置命令

命令	说明	使用场景
`/config`	打开系统设置面板	配置模型、服务商、插件等
`/upgrade`	检查并升级	更新 OpenDesk
`/dashboard`	打开全屏仪表盘	查看详细统计信息
`/dashboard bar`	切换底部状态栏显示	显示/隐藏状态栏
`/notification`	打开通知中心	查看所有通知
`/manual`	打开使用手册	查看完整文档

记忆与上下文

命令	说明	使用场景
`/memory add [提示]`	提取并保存记忆	记住重要信息
`/memory search <查询>`	搜索记忆并注入	引用历史信息
`/memory list`	列出所有记忆	查看已保存的记忆
`/memory forget <描述>`	删除匹配的记忆	清除不需要的记忆
`/btw <问题>`	快速提问（无上下文）	问独立问题

调试与日志

命令	说明	使用场景
`/debug log on`	开启调试日志	排查问题时查看详细日志
`/debug log off`	关闭调试日志	调试完成后关闭
`/debug taskid`	显示当前任务 ID	需要引用任务 ID 时查看
`/log off`	隐藏日志面板	调试完成后关闭
`/log last`	显示最后 10 条日志	快速查看最近的日志输出
`/log all`	显示全部日志	查看完整的调试信息

4. 键盘快捷键

全局快捷键

快捷键	功能	说明
`Ctrl+N`	新建任务	开始一个新的对话
`Ctrl+L`	切换任务	在多个任务间切换
`Ctrl+C`	取消/退出	取消当前输入或退出程序
`Esc`	关闭弹窗	关闭当前打开的面板/弹窗

输入区域快捷键

快捷键	功能	说明
`Enter`	发送消息	发送当前输入
`Ctrl+Enter`	换行	在输入中换行
`Tab`	自动补全	补全命令或路径
`↑` / `↓`	历史浏览	查看之前输入的内容
`Backspace`	删除字符
`Ctrl+Backspace`	删除到词首	快速删除单词
`Ctrl+Up`	向上滚动	滚动内联面板内容
`Ctrl+Down`	向下滚动	滚动内联面板内容

5. 任务与会话管理

任务状态

状态	说明	界面提示
`idle` ⏸️	空闲，等待输入	输入框可输入
`running` ⚡	运行中，处理请求	显示进度动画
`completed` ✅	已完成	任务标记为完成
`error` ❌	出错	显示错误信息

消息队列机制

当 AI 正在处理时，你输入的新消息会进入队列，依次执行。

队列管理：

使用 /cancel 清空队列中所有待发送消息
队列消息会在当前任务完成后自动执行

上下文压缩

当对话过长接近 Token 上限时，使用 /compact 命令压缩上下文。

两种压缩方式：

类型	说明	适用场景
微压缩	快速压缩，保留关键信息	日常使用，轻度压缩
全压缩	生成会话记忆摘要	长对话，深度压缩

⚠️ 提示：系统会在上下文接近溢出时自动提醒你进行压缩。

6. 高级特性

无头模式 (Headless)

适用场景：CI/CD、自动化脚本、批量处理

输出格式：

[用户] — 你的输入（青色）
[助手] — AI 回复（绿色）
[思考] — 推理过程（灰色）
[工具调用] — 工具调用卡片
[错误] — 错误信息（红色）

执行统计输出示例

────────────────────────────────────────────────────────────
任务完成
  执行时间: 1m 23.5s
  Token 消耗: 12500 (prompt: 3200, completion: 9300)
────────────────────────────────────────────────────────────

⚠️ 权限处理说明：无头模式下，所有权限请求自动拒绝并输出警告日志。

示例

# 简单任务
opendesk -c "Hello World 的 Go 语言实现" --headless

# 带导出
opendesk -c "分析这个日志文件" --export-html analysis.html --headless

# CI/CD 集成
opendesk /path/to/project -c "代码审查" --model gpt-4 --export-json result.json --headless

插件系统

OpenDesk 兼容 OpenClaw 的插件架构，支持运行时安装、启用/禁用第三方插件。

# 安装插件 (npm包名、路径或 .tgz 文件 URL)
opendesk plugins install <spec>

# 卸载插件
opendesk plugins uninstall <插件ID>

# 列出插件
opendesk plugins list

# 启用插件
opendesk plugins enable <插件ID>

# 禁用插件
opendesk plugins disable <插件ID>

输出示例

已安装的插件:
  my-plugin (npm:@example/my-plugin) [✓ enabled] installed: 2024-01-15
  another-plugin (path:./plugins/another) [✗ disabled] installed: 2024-01-10

工具管理

列出工具

opendesk tools list

输出示例：

[filesystem]
  read_file    - 读取文件内容
  write_file   - 写入文件内容
  list_dir     - 列出目录内容

[search]
  web_search   - 网络搜索
  bing_search  - Bing 搜索

查看工具详情

opendesk tools info <工具名>

直接调用工具

# 无参数调用
opendesk tools call list_dir

# 带参数调用
opendesk tools call read_file '{"path": "./README.md"}'

记忆系统

OpenDesk 支持长期记忆，分为两种类型：

类型	范围	使用场景
全局记忆	所有工作空间共享	用户偏好、通用知识
工作空间记忆	仅当前工作空间	项目信息、特定配置

记忆命令示例：

# 自动提取记忆
/memory add

# 带提示提取
/memory add 请记住我偏好使用 TypeScript

# 搜索并注入记忆
/memory search 我的项目配置

# 查看所有记忆
/memory list

# 删除记忆
/memory forget 关于Python的项目

AI 会自动判断每条记忆应保存到全局还是工作空间。

文件扫描配置

让 AI 能通过语义搜索快速找到文件。

配置步骤：

输入 /config 打开设置
选择 文件扫描配置
添加要扫描的目录（支持 ~ 展开）

功能：

🔍 文件名语义搜索 — “找配置相关的文件”
📄 文件内容语义搜索 — “搜索包含 xxx 的文件”
⚡ 增量扫描 — 仅扫描新增或修改的文件

💡 前置条件：需配置向量嵌入模型（在模型服务商配置中添加）。

技能系统 (Skills)

OpenDesk 兼容 Anthropic Agent Skills 标准，支持多来源安装：

安装方式：直接对话安装

帮我安装 xxx 技能

导出技能：

/export skill <技能名> <路径.zip>

安装后技能会自动注册为工具。

消息渠道

让 AI 7×24 小时在线，支持多种渠道：

支持渠道：

🏢 企业办公：飞书
💬 日常沟通：微信

CLI 管理：

opendesk channels list    # 列出渠道
opendesk channels info    # 检查状态

MCP 服务器

一句话安装第三方 MCP Server：

帮我安装 xxx MCP Server

OpenDesk 会自动搜索、配置并安装。

配置导入导出

导出配置口令：

/quickpass config base  # 基础配置
/quickpass config all   # 全部配置

口令格式示例：

[[Opendesk 基础设置口令 -- eyJkZWZhdWx0X21v...]]

导入配置：在 TUI 输入框粘贴完整口令字符串即可。

升级与更新

TUI 中升级：

/upgrade

可选择稳定版或日构建版。

应用技能速查

OpenDesk 通过技能（Skills）扩展功能，以下是最常用的技能分类速查。

邮箱管理 (mailbox)

技能名称：manage-mailbox + operate-mailbox

功能：邮箱账号配置和邮件收发管理

邮箱账号配置 (manage-mailbox)

使用方式：

添加我的邮箱账号
查看已配置的邮箱账号
切换到另一个邮箱账号
删除某个邮箱账号
查看邮件同步状态

邮件操作 (operate-mailbox)

使用方式：

查看最近10封邮件
搜索来自xxx的邮件
阅读某封邮件的内容
发送一封邮件给xxx
回复某封邮件
标记邮件已读/未读
收藏或删除邮件

注意事项：

配置邮箱账号后需要新建会话才能使用（/new 或 Ctrl+N)
添加账号时会验证收信和发信连接
部分邮箱需要授权码而非登录密码

文件扫描状态 (fs-status)

命令：/fs-status

功能：查看文件扫描器的状态和统计信息

使用方式：

/fs-status

输出内容：

Scanner 状态（首次扫描/增量扫描）
扫描目录文件数量统计
最近全量扫描时间
待处理文件数

适用场景：

确认文件是否已被扫描索引
检查语义搜索功能可用性
查看扫描进度和状态

全局待办管理 (manage-global-todos)

技能名称：manage-global-todos

功能：管理跨任务持久保存的待办事项

支持三种触发方式：

触发类型	说明	示例
定时触发	设置固定时间执行一次	”明天上午9点提醒我开会”
周期触发	Crontab风格定期执行	”每个工作日早上提醒写日报”
事件触发	应用事件发生时执行	”收到新邮件时提醒处理”

使用方式：

添加一个待办事项
明天提醒我检查邮件
每个周一早上提醒我写周报
查看所有待办事项
标记某个待办为已完成
删除某个待办

消息渠道管理 (manage-channels)

技能名称：manage-channels

功能：管理第三方消息渠道接入（微信、飞书等）

支持渠道：

🏢 飞书
💬 微信

使用方式：

登录飞书
登录微信
查看渠道连接状态
配置飞书机器人
查看待配对的用户请求
审批某个用户的配对请求

典型应用：

让 AI 7×24 小时在线
通过飞书/微信与 AI 对话
团队协作和通知推送

知识库管理 (knowledgebase)

技能名称：manage-knowledgebase + operate-knowledgebase

功能：知识库配置和检索

知识库配置 (manage-knowledgebase)

使用方式：

配置智谱AI知识库
查看所有知识库服务商
创建新知识库
删除某个知识库

知识库操作 (operate-knowledgebase)

使用方式：

列出所有知识库
从知识库检索相关内容
基于知识库回答问题
添加文件到知识库

技能管理 (manage-skills)

技能名称：manage-skills

功能：Skills 的安装和管理

使用方式：

从本地目录添加技能
从URL下载安装技能
从GitHub仓库安装技能
查看已安装的技能列表
删除某个技能
刷新技能列表

CLI 命令：

opendesk skill install <source>
opendesk skill list
opendesk skill uninstall <skillName>

MCP 服务器管理 (manage-mcp)

技能名称：manage-mcp

功能：MCP Server 的安装和管理

使用方式：

安装某个 MCP Server
查看已安装的 MCP Servers
启用或禁用某个 MCP Server
卸载 MCP Server

搜索平台：

mcpservers.org
mcp.so

搜索工具配置 (manage-search-tools)

技能名称：manage-search-tools

功能：搜索引擎配置

支持引擎：

网页搜索：DuckDuckGo、Bing、Tavily、Brave、博查、Exa
学术搜索：arXiv

使用方式：

配置 Tavily 搜索引擎
设置默认搜索引擎
启用或关闭搜索工具

设备管理 (manage-devices)

技能名称：manage-devices

功能：管理通过 OpenClaw Node 协议接入的设备

使用方式：

查看设备网关状态
查看在线设备列表
查看已配对设备
审批设备配对请求
向设备发送远程命令（如拍照）

典型应用：

远程控制 iOS/Android 设备
设备摄像头拍照、屏幕录制
画布导航和截图

7. 参考速查表

CLI 参数速查

opendesk [options]

# 工作空间选项
  --workspace <path>     工作空间目录（默认：当前目录）

# 常用选项
--model <alias>        # 指定模型
-c, --command <cmd>    # 执行命令
--export-html <path>   # 导出 HTML
--export-json <path>   # 导出 JSON
--dump-log <path>      # 日志文件
--headless             # 无头模式
-v, --version          # 版本

# 子命令
plugins install|uninstall|list|enable|disable|reset-openclaw-shim
tools list|info|call
channels list|info

快捷键速查

快捷键	功能
`Ctrl+N`	新建任务
`Ctrl+L`	切换任务
`Ctrl+C`	取消/退出
`Shift+Tab`	切换模式
`Esc`	关闭弹窗
`Tab`	命令补全
`Enter`	发送消息
`↑` `↓`	浏览历史

斜杠命令速查

最常用：

/new — 新建任务
/switch — 切换任务
/stop — 停止任务
/compact — 压缩上下文
/config — 打开设置

任务管理：

/undo /redo — 撤销/恢复
/fork — 复制会话
/bookmark — 书签管理

导出导入：

/export /import — 导出/导入任务

系统：

/memory — 记忆管理
/upgrade — 升级程序
/dashboard — 打开仪表盘
/notification — 打开通知中心
/manual — 打开使用手册

常见问题

配置问题

Q: 首次启动显示”模型未配置”

解决方案：

输入 /config
模型服务商配置 → 添加服务商
模型配置 → 添加模型
默认模型配置 → 设为默认

Q: 配置保存在哪里？

配置文件位置：

macOS/Linux: ~/.opendesk/setting.json
Windows: %APPDATA%/opendesk/setting.json

运行问题

Q: 命令执行后无响应？

排查步骤：

等待 AI 处理完成（查看状态栏）
使用 /stop 停止后重试
检查网络连接
开启调试日志：/debug log on

Q: 无法安装插件？

检查项：

npm 源是否可访问
插件包名是否正确
是否有写权限

文件问题

Q: 导出文件失败？

检查项：

指定路径是否存在
是否有写权限
磁盘空间是否充足

使用问题

Q: 如何退出 OpenDesk CLI？

输入 /exit 命令

Q: 可以同时运行多个 CLI 实例吗？

可以，但建议在不同工作区目录运行，避免配置冲突。

让 AI 成为你最得力的助手

遇到问题？直接在 OpenDesk 中说：“我遇到了 xxx 问题”