Klee项目安装与配置指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00231/article/details/146801995

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是一个开源项目，旨在为用户提供一个带有内置RAG知识库和Markdown笔记功能的桌面AI。这个项目允许用户在没有互联网连接的情况下使用本地模式，以保护用户隐私。

主要编程语言：TypeScript

2. 项目使用的关键技术和框架

Electron：用于创建桌面应用程序的框架。
React：用于构建用户界面的JavaScript库。
TypeScript：JavaScript的一个超集，添加了静态类型。
Vite：一个用于构建前端项目的现代工具。
Tailwind CSS：一个功能类优先的CSS框架。
Radix UI：用于构建用户界面的React组件库。
i18next：一个国际化框架。
React Query：用于数据同步的React钩子库。
Jotai：一个状态管理库。

3. 项目安装和配置的准备工作

在开始安装之前，请确保您的系统满足以下要求：

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，并根据您的需求编辑.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（或您在VITE_REQUEST_PREFIX_URL中指定的端口）上运行，以便客户端可以正常连接。
在开发模式下运行

使用以下命令在开发模式下启动应用程序：
```
yarn dev
```
这个命令将启动Vite开发服务器和Electron应用程序。
构建应用程序（可选）

如果需要构建应用程序，可以执行以下命令：
```
yarn build
```
构建完成后，可以在dist目录中找到编译后的应用程序。