Klee 开源项目教程

Klee 开源项目教程

Klee Secure and local AI on your desktop with a built-in RAG knowledge base and Markdown note support. 项目地址: https://gitcode.com/gh_mirrors/klee3/Klee

1. 项目介绍

Klee 是一个将安全且本地的 AI 带到用户桌面上的开源项目。它具备内置的 RAG 知识库和 Markdown 笔记支持。用户可以在没有互联网连接的情况下使用本地模式，以保护个人隐私。Klee 的核心构建在 Ollama 和 LlamaIndex 上，这两个工具分别用于快速有效地运行本地大型语言模型和数据框架。

2. 项目快速启动

以下是快速启动 Klee 项目的步骤：

系统要求

• Node.js 20.x 或更高版本
• Yarn 1.22.19 或更高版本

克隆仓库

git clone https://github.com/signerlabs/klee-client.git
cd klee-client

安装依赖

yarn install

配置环境变量

将 .env.example 文件复制为 .env 文件：

cp .env.example .env

编辑 .env 文件，根据需求配置以下环境变量：

# 基本配置
# 远程模式配置
# 设置为 'true' 启用远程模式，'false' 使用本地模式（默认为 'false'）
VITE_USE_SUPABASE=false

# Supabase 配置（仅当 VITE_USE_SUPABASE=true 时需要）
# 这些用于配置你自己的远程服务
# 如果未指定，系统将使用我们默认部署的服务
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
VITE_SUPABASE_URL=your_supabase_url
VITE_SUPABASE_AUTH_CALLBACK_URL=your_callback_url

# Ollama 服务地址（默认: http://localhost:11434）
VITE_OLLAMA_BASE_URL=http://localhost:11434

# 本地 Python 服务地址（默认: http://localhost:6190）
VITE_REQUEST_PREFIX_URL=http://localhost:6190

设置后台服务

在运行客户端之前，需要设置并启动后台服务：

git clone https://github.com/signerlabs/klee-service.git
cd klee-service

按照后台服务仓库中的安装说明来设置和启动服务。后台服务需要在端口 6190（或在 .env 文件中指定的端口）上运行，以便客户端可以正确连接。

开发模式运行

yarn dev

此命令将启动 Vite 开发服务器和 Electron 应用程序。

构建应用（可选）

yarn build

macOS 应用签名和公证（可选）

如果需要为 macOS 构建签名应用程序，请编辑 .env 文件：

# Apple ID 账户
APPLEID=your_apple_id@example.com

# Apple ID 密码或应用专用密码
APPLEIDPASS=your_apple_id_password

# Apple 开发者团队 ID
APPLETEAMID=your_team_id

构建完成后，可以在 dist 目录中找到编译后的应用程序。

3. 应用案例和最佳实践

（本部分将介绍 Klee 的实际应用案例和最佳实践，但由于信息有限，具体内容需根据项目的实际应用场景来编写。）

4. 典型生态项目

（本部分将列出与 Klee 相关的典型生态项目，但由于信息有限，具体项目需根据实际的开源生态来填写。）

Klee Secure and local AI on your desktop with a built-in RAG knowledge base and Markdown note support. 项目地址: https://gitcode.com/gh_mirrors/klee3/Klee