使用手册

简介

OpenDesk CLI 是 OpenDesk（一站式跨平台 AI 办公套件）的命令行版本。它提供了基于终端的文本用户界面（TUI），让您可以在不启动桌面应用的情况下使用 OpenDesk 的全部核心功能：AI 对话、任务管理、文件操作、邮件收发、日程管理等。

安装与启动

通过 npm 安装

运行以下命令安装最新稳定版本：

$ npm install -g @bitclub.ai/opendesk-cli
$ opendesk

或安装 Nightly（每日构建）版本以体验最新功能：

$ npm install -g @bitclub.ai/opendesk-cli@nightly
$ opendesk

命令行参数

opendesk [workspace] [选项]

使用示例

# 在当前目录启动
$ opendesk

# 在指定目录启动
$ opendesk /path/to/workspace

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

# 一次性执行命令
$ opendesk -c "分析当前目录的代码结构"

模型配置

OpenDesk 通过集中式配置管理 AI 模型。您需要先配置模型服务商（Provider），再添加模型（Model），最后设置默认模型。

首次配置流程

1. 1 输入 /config 打开配置菜单
2. 2 选择 "模型服务商配置"，添加一个模型服务商（如 OpenRouter、OpenAI 等）
3. 3 选择 "模型配置"，添加一个具体的模型
4. 4 选择 "默认模型配置"，选择您要使用的默认模型

服务商配置

每个服务商需要配置以下信息：

模型配置

每个模型需要配置以下信息：

默认模型类型

OpenDesk 支持为不同场景配置独立的默认模型：

配置文件位置

配置以 JSON 格式存储在用户数据目录中：

配置文件示例

{
  "default_model": "gemini-2.5-flash",
  "default_intent_parsing_model": "gemini-2.0-flash",
  "default_embedding_model": "text-embedding-3-small",
  "default_reranker_model": "rerank-english-v3.0",
  "default_vision_model": "gemini-2.0-flash",
  "providers": [
    {
      "name": "openrouter",
      "base_url": "https://openrouter.ai/api/v1",
      "api_key": "sk-xxx...",
      "no_proxy": false
    }
  ],
  "models": [
    {
      "alias": "gemini-2.5-flash",
      "provider_name": "openrouter",
      "model_name": "google/gemini-2.5-flash"
    }
  ]
}

斜杠命令

在输入框中输入 / 即可查看可用命令列表并触发自动补全。所有命令均以 / 开头。

全局命令

应用命令

以下命令来自内置应用，用于打开对应的应用界面：

命令详细说明

/new
/new 分析这个项目的代码结构

/export my-session.html
/export

/bookmark add       # 将当前任务添加到书签
/bookmark list      # 查看所有书签
/bookmark remove    # 从书签中移除当前任务

/log all     # 显示所有日志
/log last    # 显示最后 10 条日志
/log off     # 关闭日志显示

/debug log on    # 开启调试日志
/debug log off   # 关闭调试日志
/debug log       # 查看当前调试日志状态
/debug taskid    # 显示当前任务ID

/memory add         # 从当前对话中提取并保存有价值的记忆（后台执行）
/memory search 关键词  # 语义搜索相关记忆并注入对话上下文
/memory forget 描述   # 根据描述智能删除匹配的记忆
/memory list        # 打开记忆浏览面板，查看/筛选所有记忆

/quickpass config base  # 导出基础设置口令（不含应用配置）
/quickpass config all   # 导出全部设置口令（含应用配置）

快捷键

上下文压缩

在长时间的对话中，上下文会不断增长并可能接近模型的上下文窗口限制。OpenDesk 提供了两级上下文压缩机制，可以自动或手动压缩上下文，确保对话流畅进行。

自动触发

当已使用的 prompt tokens 达到模型上下文窗口的 80% 时，系统会自动触发上下文压缩。OpenDesk 会先查询内置的模型上下文大小表，如果查不到则通过 API 获取。

手动触发

您可以随时使用 /compact 命令手动触发上下文压缩。

两级压缩机制

压缩流程

安装 MCP Server

MCP (Model Context Protocol) 是一种标准协议，用于让 AI 模型使用外部工具和数据源。OpenDesk 支持自动搜索、下载、安装和管理 MCP Server，无需手动编写配置文件。

对话式安装

最简单的方式是直接告诉 AI 助手您需要什么功能，它会自动搜索并安装合适的 MCP Server。

# 直接用自然语言描述需求
帮我安装一个可以操作文件系统的 MCP Server
帮我安装一个 GitHub MCP Server

MCP Server 配置参数

每个 MCP Server 支持以下配置：

管理工具

AI 助手内置了以下 MCP 管理工具，您可以通过自然语言调用：

从其他工具导入

OpenDesk 支持从 Claude Desktop 或 Cursor 的 MCP 配置 JSON 文件中批量导入 MCP Server 配置。

安装 Skill 技能

Skill（技能）是 OpenDesk 的扩展能力单元，每个技能是一个包含 SKILL.md 文件的目录，兼容 Anthropic Agent Skills 格式。技能可以从在线平台或本地路径安装。

安装来源

对话式安装

# 搜索并安装技能
帮我搜索一个可以创建 Cursor Rule 的技能并安装

# 从 Registry 安装
帮我从 matrix 安装刚才搜索到的 cursor-rule 技能

# 查看已安装技能
列出所有已安装的技能

管理工具

使用 /skills 命令

输入 /skills 命令可以打开技能管理界面，查看和管理所有已安装的技能。

邮箱配置

OpenDesk CLI 内置了邮箱应用，支持收发邮件。您可以通过对话式配置来添加邮箱账户，系统会自动识别常见的邮箱服务商并使用预设配置。

对话式配置

# 添加邮箱账户
帮我配置 QQ 邮箱，邮箱地址是 user@qq.com

# 查看已配置的邮箱
列出我的邮箱账户

# 切换默认邮箱
切换到我的 163 邮箱

支持的邮箱服务商

OpenDesk 预置了以下邮箱服务商的服务器配置：

邮箱账户配置参数

使用邮箱

配置完成后，可以使用 /mail 命令打开邮箱界面查看和管理邮件，也可以直接通过自然语言让 AI 助手帮您收发邮件。

# 查看邮件
帮我看看最新的邮件

# 发送邮件
帮我给 colleague@example.com 发一封邮件，主题是"会议安排"

日历配置

OpenDesk 内置日历应用，支持本地日程管理，并可选择同步 Outlook 日历数据（仅 Windows 平台）。

数据源

配置 Outlook 同步

进入 /config 配置菜单，在日历应用的配置中启用 Outlook 数据源：

{
  "applications": {
    "calendar": {
      "dataSources": {
        "outlook": {
          "enabled": true
        }
      }
    }
  }
}

使用日历

使用 /calendar 命令打开日历界面，或通过自然语言让 AI 助手管理日程。

# 查看今天的日程
今天有什么安排？

# 添加日程
帮我在明天下午 2 点添加一个会议，主题是"项目评审"

# 删除日程
帮我取消今天下午的会议

日程参数

应用概览

OpenDesk 桌面版包含丰富的内置应用，以下是各应用的简要介绍。详细使用文档正在编写中。