Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/01-getting-started/01-system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ keywords: [系统要求, 硬件, 操作系统, 兼容性]

DesireCore 桌面客户端支持 macOS、Windows、Linux 三大平台。下面列出了各平台的环境要求。

:::tip 快速判断
如果你的电脑是近 3 年内购买的,基本都能流畅运行 DesireCore。最低只需要 8 GB 内存和 2 GB 磁盘空间。
:::

## 桌面版

### macOS
Expand Down
32 changes: 27 additions & 5 deletions docs/01-getting-started/02-installation/01-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ keywords: [Windows, 安装, NSIS, SmartScreen]

本指南介绍如何在 Windows 上安装 DesireCore。

:::tip 预计耗时
整个安装过程通常只需 **1-2 分钟**(取决于下载速度)。
:::

## 安装步骤

1. **下载安装包**
Expand Down Expand Up @@ -39,13 +43,25 @@ keywords: [Windows, 安装, NSIS, SmartScreen]

## 随安装包提供的本地组件

Windows 版会随包提供可移植 Git、推荐的 Python/Node.js 运行时归档,以及用于本机 GUI 自动化的 CUA Driver。它们是独立第三方组件,不会要求你提前安装系统 Git、Python、Node.js 或 HostAgent。
Windows 版会随包提供以下独立第三方组件,不需要你提前安装系统 Git、Python、Node.js 或 HostAgent。

### 可移植 Git

安装包内含便携版 Git。首次启动后,DesireCore 会在系统版本与内置版本中自动选择可用且较新的来源。你也可以在 **资源管理器** → **算力** → **运行环境** 手动切换。

### Python / Node.js 运行时

DesireCore 会在首次启动后,将推荐的 Python 和 Node.js 版本导入其管理目录(后台完成)。这不会替换你系统全局安装的版本。

- 首次启动后,DesireCore 会在后台把推荐的 Python 和 Node.js 导入其管理目录;这不会替换系统全局版本。
- Git 默认在系统版本与内置版本中自动选择可用且较新的来源,你也可以在运行环境页手动切换。
- CUA Driver 仅用于当前 Windows 电脑的 GUI 自动化,默认启用。它是 Windows HostAgent 完成前的权宜/过渡实现,让 Windows 用户先具备相关能力;macOS 当前仍由 HostAgent 承载 GUI 操作,Windows、Linux 和其他平台的 HostAgent 仍在开发。
### CUA Driver(GUI 自动化)

这些归档和可执行程序会增加安装包与首次启动后的磁盘占用。安全软件也可能在首次解包或运行时再次扫描它们;请等待扫描完成,不要通过关闭系统防护来强行绕过告警。你可以在 **资源管理器** → **算力** → **运行环境** 查看实际版本与路径。许可和来源说明见 [第三方软件与许可](../../05-more/09-third-party-software.md)。
CUA Driver 仅用于当前 Windows 电脑的 GUI 自动化,默认启用。它是 Windows HostAgent 完成前的过渡实现,让 Windows 用户先具备 GUI 操作能力。macOS 当前仍由 HostAgent 承载 GUI 操作,Windows、Linux 和其他平台的 HostAgent 仍在开发中。

:::note 磁盘占用与安全扫描
这些归档和可执行程序会增加安装包与首次启动后的磁盘占用。安全软件也可能在首次解包或运行时再次扫描它们;请等待扫描完成,不要通过关闭系统防护来强行绕过告警。
:::

你可以在 **资源管理器** → **算力** → **运行环境** 查看实际版本与路径。许可和来源说明见 [第三方软件与许可](../../05-more/09-third-party-software.md)。

## 处理 Windows SmartScreen 提示

Expand Down Expand Up @@ -83,4 +99,10 @@ Windows 版会随包提供可移植 Git、推荐的 Python/Node.js 运行时归
卸载时会提示是否同时删除应用数据。如果你计划重新安装,建议保留数据;如果确定不再使用,可以选择一并删除。
:::

## 遇到问题?

- **安装程序无法打开**:确认文件下载完整(大小约 100-200 MB),尝试重新下载。
- **杀毒软件拦截**:将 DesireCore 安装目录加入白名单,或暂时关闭实时防护后重试。
- **其他问题**:前往 [常见问题](../../06-faq/index.md) 或联系支持团队。

安装完成后,前往 [首次启动](../03-first-run.md) 了解启动后的引导流程。
11 changes: 11 additions & 0 deletions docs/01-getting-started/02-installation/02-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ keywords: [macOS, 安装, DMG, Gatekeeper, Apple Silicon, Intel]

本指南介绍如何在 macOS 上安装 DesireCore。

:::tip 预计耗时
整个安装过程通常只需 **1 分钟**——下载 DMG、拖入 Applications 即完成。
:::

## 安装步骤

1. **下载 DMG 文件**
Expand Down Expand Up @@ -72,4 +76,11 @@ DesireCore 的安装包已经过 Apple 公证(Notarization),是安全的
~/.desirecore/
```

## 遇到问题?

- **DMG 无法打开**:确认文件下载完整,尝试重新下载。
- **"已损坏,无法打开"提示**:这通常是 Gatekeeper 拦截,按上方"处理 Gatekeeper 提示"操作即可。
- **Apple Silicon 用户运行缓慢**:确认下载的是 arm64 版本而非 x64 版本(Rosetta 转译会有性能损耗)。
- **其他问题**:前往 [常见问题](../../06-faq/index.md) 或联系支持团队。

安装完成后,前往 [首次启动](../03-first-run.md) 了解启动后的引导流程。
18 changes: 16 additions & 2 deletions docs/01-getting-started/02-installation/03-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ keywords: [Linux, 安装, AppImage, Ubuntu, Fedora, ARM64, 统信UOS, 银河麒

本指南介绍如何在 Linux 上安装 DesireCore。DesireCore 以 AppImage 格式分发,支持 x64 和 ARM64 架构,兼容大多数主流 Linux 发行版,同时也支持统信 UOS、银河麒麟、深度 Deepin、openKylin 等国产操作系统。

:::tip 老手速览
```bash
# 下载后两步即可运行
chmod +x DesireCore_x86_64_*.AppImage
./DesireCore_x86_64_*.AppImage
```
如遇沙箱报错,请直接跳到 [常见问题排查](#常见问题排查)。
:::

:::tip 国产操作系统用户
DesireCore 已在统信 UOS、银河麒麟(Kylin)、深度 Deepin、openKylin 等国产操作系统上完成适配测试。如需了解国产系统专属的安装说明和兼容性信息,请访问 [DesireCore 中国官网](https://www.desirecore.cn)。
:::
Expand Down Expand Up @@ -112,6 +121,9 @@ Trace/breakpoint trap (core dumped)

这是因为 DesireCore 基于 Electron 构建,其 Chromium 内核需要 Linux **unprivileged user namespaces** 支持来运行沙箱。部分发行版(尤其是 Ubuntu 24.04+)默认通过 AppArmor 限制了此功能。

<details>
<summary><strong>🔧 完整排查与修复步骤</strong>(点击展开)</summary>

#### 第一步:诊断问题

在终端运行以下命令,确认系统的 user namespaces 状态:
Expand Down Expand Up @@ -172,7 +184,9 @@ sudo sysctl --system
~/Apps/DesireCore/DesireCore.AppImage
```

#### 临时验证:快速测试应用能否运行
</details>

#### 快速验证:临时测试应用能否运行

如果你只想先确认应用本身是否正常,可以临时禁用沙箱运行(**仅用于测试,不建议日常使用**):

Expand All @@ -188,7 +202,7 @@ echo 0 | sudo tee /proc/sys/kernel/apparmor_restrict_unprivileged_userns
```

:::warning
`--no-sandbox` 会关闭 Chromium 的进程沙箱隔离,降低安全性。请仅用于排查问题,不要作为日常启动方式。建议按照上述方案一或方案二进行正式配置
`--no-sandbox` 会关闭 Chromium 的进程沙箱隔离,降低安全性。请仅用于排查问题,不要作为日常启动方式。建议按照 [上方的完整排查步骤](#完整排查与修复步骤点击展开) 进行正式配置

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Point the Chinese sandbox warning at a real anchor

This link targets text that only exists inside the <summary> of the <details> block, so the page does not define a #完整排查与修复步骤点击展开 heading anchor. When users run with --no-sandbox and then click the recommended formal fix path, they won't be taken back to the AppArmor/sysctl steps; link to an actual heading in that section or give the details block an explicit id.

Useful? React with 👍 / 👎.

:::

## 卸载
Expand Down
4 changes: 4 additions & 0 deletions docs/01-getting-started/02-installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ keywords: [安装, 下载, macOS, Windows, Linux]

DesireCore 桌面客户端支持 macOS、Windows 和 Linux 三大平台。

:::info 安装前确认
请先确保你的设备满足 [系统要求](../01-system-requirements.md)(8 GB 内存、2 GB 磁盘空间、可访问互联网)。
:::

## 下载

前往 DesireCore 官网,点击下载按钮即可获取最新版本:
Expand Down
54 changes: 45 additions & 9 deletions docs/01-getting-started/03-first-run.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 首次启动
description: DesireCore 首次启动后的欢迎引导流程和主界面概览。
keywords: [首次启动, 欢迎, 引导, 界面, 主窗口]
keywords: [首次启动, 欢迎, 引导, 界面, 主窗口, 权限, 三栏布局, 导航栏]
---

# 首次启动
Expand All @@ -18,31 +18,67 @@ keywords: [首次启动, 欢迎, 引导, 界面, 主窗口]

这个过程通常只需要几秒钟,你会看到一个简短的加载画面。

## 权限授予

根据你的操作系统,DesireCore 首次运行时可能会请求以下权限:

| 权限 | 平台 | 用途 | 是否必需 |
|------|------|------|----------|
| **辅助功能(Accessibility)** | macOS | GUI 自动化——让智能体操控其他应用窗口 | 可选,用到 GUI 自动化时才需要 |
| **屏幕录制(Screen Recording)** | macOS | 屏幕截图——让智能体看到屏幕内容 | 可选,用到屏幕感知时才需要 |
| **网络访问** | 全平台 | 调用 AI 模型 API、同步数据 | 必需 |
| **本地文件访问** | 全平台 | 读写工作文件和知识库 | 必需 |

:::info macOS 用户
macOS 会在首次请求时弹出系统权限对话框。如果拒绝了某项权限,后续可以在 **系统设置** → **隐私与安全性** 中随时开启。你也可以稍后在 DesireCore 的 **设置** → **系统权限** 中查看和管理权限状态。
:::

:::tip 最小权限原则
DesireCore 采用最小权限设计——只在实际需要时才请求权限。初次体验时,即使不授予辅助功能和屏幕录制权限,对话、智能体管理等核心功能也能正常使用。
:::

## 主界面概览

启动完成后,你会进入 DesireCore 的主界面。它采用三栏布局:

![主界面布局](/img/getting-started/main-layout.svg)
![主界面布局示意图](/img/getting-started/main-layout.svg)

下面是真实界面截图(深色模式):

![DesireCore 主界面](/img/getting-started/main-interface-clean.png)

### 导航栏(左侧)

最左侧的窄条是导航栏,从上到下依次是:
最左侧的窄条是导航栏,包含核心功能入口。从上到下依次是:

- **Logo**:DesireCore 图标
- **Logo**:DesireCore 图标(点击可回到首页)
- **对话**:聊天界面(默认页面)
- **智能体**:管理你的 AI 同伴
- **知识库**:查看和管理知识资料
- **监控**:查看智能体运行状态
- **设置**:应用设置(底部)
- **头像**:你的个人信息(底部)
- **文件**:查看和管理知识资料与工作文件
- **通知**:查看系统通知和消息提醒
- **设置**:应用设置(底部区域)
- **头像**:你的个人信息和账号管理(最底部)

:::info 更多入口
导航栏中还可能包含市场、自动化、算力管理等入口,具体项目会随版本更新而变化。将鼠标悬停在图标上可查看功能名称。
:::

### 对话列表(中间)

列表展示你所有的对话会话。首次启动时,你会看到一个预置的核心智能体——**DesireCore**,它是你的通用 AI 助手。

### 聊天区域(右侧)

这是你和 AI 同伴交流的主要区域。顶部显示当前对话的智能体信息,底部是消息输入框。
这是你和 AI 同伴交流的主要区域:

- **顶部**:显示当前对话的智能体名称、在线状态和简介
- **中间**:对话消息流(首次启动时为空)
- **底部输入框**:输入消息并按 **Enter** 发送,**Shift + Enter** 换行。输入框下方还有附件(+)、图片上传、模型选择等辅助按钮
- **状态栏**(最底部):显示快捷键提示,如 `↵ 发送`、`⇧ 换行`

:::tip 提示
将鼠标悬停在导航栏图标上可查看功能名称。界面各区域的详细介绍见 [界面导航](../02-user-guide/01-interface/01-layout-overview.md)。
:::

## 下一步

Expand Down
87 changes: 87 additions & 0 deletions docs/01-getting-started/04-configure-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,71 @@ keywords: [API Key, 配置, OpenAI, Claude, DeepSeek, Gemini, 硅基流动, 供

DesireCore 是一个本地优先的应用——你的核心数据存储在本地。AI 能力可以通过两种方式接入:登录后使用官方云端算力,或配置你自己的 API Key。配置 API Key 仍然是高级用户和企业用户最常用的方式,但它已经不是唯一入口。

:::info 本页目录
- [快速开始:云端算力或自备 Key](#快速开始云端算力或自备-key)
- [什么是 API Key?](#什么是-api-key)
- [在 DesireCore 中配置](#在-desirecore-中配置)
- [各供应商 API Key 获取指南](#各供应商-api-key-获取指南)
- [更多供应商](#更多供应商)
- [验证连接](#验证连接)
- [常见问题](#常见问题)
:::

## 快速开始:云端算力或自备 Key

| 方式 | 适合谁 | 说明 |
|------|--------|------|
| 官方云端算力 | 不想先注册各家供应商的新用户 | 登录后自动绑定 `desirecore-cloud`,按订阅或 credit 使用 |
| 自备 API Key | 已有供应商账号、需要自控成本或企业合规 | API Key 存储在本机受权限保护的 `secrets.json` 中,供应商配置只保存引用 |

### 使用官方云端算力(推荐新手)

如果你不想先注册各家供应商的账号,可以使用 DesireCore 官方云端算力:

1. **登录 DesireCore 账号**
- 点击左下角的 **头像** 图标
- 选择 **登录** 或 **注册**
- 使用邮箱或第三方账号登录

2. **自动绑定云端算力**
- 登录成功后,资源面板会自动出现 **官方云端算力** 分组
- 系统会同步你当前账号可用的模型
- 显示余额、credit、临期额度和消耗信息

3. **开始使用**
- 云端算力会自动配置为默认供应商
- 你可以直接开始 [第一次对话](./05-first-conversation.md),无需额外配置

:::tip 云端算力优势
- **无需注册**:不需要在多个供应商网站注册账号
- **统一计费**:通过 DesireCore 账号统一管理消耗
- **快速开始**:登录后即可使用,无需手动配置 API Key
- **灵活切换**:后续可以随时添加自备 API Key 作为补充
:::

### 使用自备 API Key

如果你已有供应商账号,或需要自控成本、企业合规,可以配置自己的 API Key:

1. **获取 API Key**:参考下方的 [各供应商 API Key 获取指南](#各供应商-api-key-获取指南)
2. **配置到 DesireCore**:参考 [在 DesireCore 中配置](#在-desirecore-中配置)
3. **验证连接**:参考 [验证连接](#验证连接)

:::note 混合使用
手动 API Key 和官方云端算力可以并存。你可以为某些任务指定自己的供应商,其他任务使用云端算力。
:::

## 本页导航

| 快速跳转 | 说明 |
|----------|------|
| [什么是 API Key?](#什么是-api-key) | 概念解释 |
| [在 DesireCore 中配置](#在-desirecore-中配置) | 配置步骤 |
| [OpenAI](#openaigpt-系列) · [Anthropic](#anthropicclaude-系列) · [DeepSeek](#deepseek) · [Google](#googlegemini-系列) · [硅基流动](#硅基流动siliconflow) | 热门供应商获取指南 |
| [更多供应商](#更多供应商) | 其他 16+ 供应商列表 |
| [验证连接](#验证连接) | 配置后验证 |
| [常见问题](#常见问题) | 排查指引 |

## 什么是 API Key?

API Key 就像是你访问 AI 服务的"钥匙"。每个 AI 供应商(如 OpenAI、Anthropic、DeepSeek 等)都提供 API 服务,你需要在它们的网站上注册并获取一个 API Key,然后在 DesireCore 中填入,DesireCore 就能调用对应的 AI 模型了。
Expand All @@ -33,12 +91,19 @@ API Key 就像是你访问 AI 服务的"钥匙"。每个 AI 供应商(如 Open

<!-- 截图占位: 配置 API Key (configure-api-key.png) -->

:::note 密钥安全
你的 API Key 仅保存在本机的 `~/.desirecore/secrets.json` 中(文件权限为 `600`,仅当前用户可读),不会上传到 DesireCore 服务器或任何第三方。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Point users to the actual secrets file

For users trying to inspect, secure, or migrate their credentials, this path is wrong: the rest of the documentation consistently identifies the file as ~/.desirecore/config/secrets.json. The unconditional 600 claim is also inaccurate on Windows, where protection relies on account and directory ACLs rather than POSIX mode bits, so the note should use the real path and make the permission statement platform-specific in both locales.

Useful? React with 👍 / 👎.

:::

## 各供应商 API Key 获取指南

DesireCore 支持超过 20 个 AI 供应商。下面是最常用的几个供应商的获取方法。

### OpenAI(GPT 系列)

<details>
<summary>点击展开 OpenAI API Key 获取指南</summary>

OpenAI 提供 GPT-5、GPT-4 等模型,是全球最知名的 AI 供应商之一。

| 项目 | 信息 |
Expand All @@ -60,8 +125,13 @@ OpenAI 提供 GPT-5、GPT-4 等模型,是全球最知名的 AI 供应商之一
API Key 只会显示一次,请立即复制并保存。如果丢失了,你需要重新创建一个。
:::

</details>

### Anthropic(Claude 系列)

<details>
<summary>点击展开 Anthropic API Key 获取指南</summary>

Anthropic 提供 Claude 系列模型,以安全性和长文本处理能力著称。

| 项目 | 信息 |
Expand All @@ -78,8 +148,13 @@ Anthropic 提供 Claude 系列模型,以安全性和长文本处理能力著
3. 点击 **Create Key**
4. 复制生成的 Key(以 `sk-ant-` 开头)

</details>

### DeepSeek

<details>
<summary>点击展开 DeepSeek API Key 获取指南</summary>

DeepSeek 是国内领先的 AI 公司,提供高性价比的对话和推理模型,API 服务器在国内,延迟低。

| 项目 | 信息 |
Expand All @@ -95,8 +170,13 @@ DeepSeek 是国内领先的 AI 公司,提供高性价比的对话和推理模
2. 进入控制台,点击 **API Keys**
3. 创建新的 API Key 并复制

</details>

### Google(Gemini 系列)

<details>
<summary>点击展开 Google API Key 获取指南</summary>

Google 提供 Gemini 系列模型,拥有超长上下文窗口(最高 100 万 Token)。

| 项目 | 信息 |
Expand All @@ -113,8 +193,13 @@ Google 提供 Gemini 系列模型,拥有超长上下文窗口(最高 100 万
3. 选择或创建 Google Cloud 项目
4. 复制生成的 API Key

</details>

### 硅基流动(SiliconFlow)

<details>
<summary>点击展开硅基流动 API Key 获取指南</summary>

硅基流动是国内的 AI 推理服务平台,聚合了多种开源模型(如 Qwen),部分模型提供免费额度。

| 项目 | 信息 |
Expand All @@ -130,6 +215,8 @@ Google 提供 Gemini 系列模型,拥有超长上下文窗口(最高 100 万
2. 进入控制台,找到 **API 密钥** 页面
3. 创建新的密钥并复制

</details>

## 更多供应商

除了上面列出的供应商,DesireCore 还支持以下服务:
Expand Down
Loading
Loading