Skip to content

五分钟上手 ​

首次进入应用后,完成下面三步就能开始提问。

第 1 步:添加知识库 ​

打开 设置 → 知识库管理,添加一个本地目录。

  • 这个目录就是橘记的知识库根目录,里面的 Markdown / TXT 文件会被索引。
  • 可以添加多个知识库,每个知识库是独立的授权范围。
  • 移除授权不会删除磁盘上的文件。

添加后橘记会建立 Markdown 全文索引,并展示目录树。

第 2 步:配置模型 ​

打开 设置 → 模型设置,添加并启用一个模型服务。

支持三类接入方式:

类型说明
OpenAI 兼容接口填 Base URL + API Key,适用于大多数兼容服务
本地 Ollama指向本机 Ollama 服务
本地 LM Studio指向本机 LM Studio 服务

API Key 会保存到系统安全存储(macOS Keychain / Windows 凭据管理器),不会写进项目数据库,界面和日志也不会回显明文。

本地模型

如果只使用本地 Ollama / LM Studio,笔记内容完全不需要离开本机。

第 3 步:新建会话并确认范围 ​

新建一个会话,确认当前会话可用的知识库范围,然后就可以提问了。

试试这些:

  • 「帮我找一下关于检索设计的笔记」
  • 「把这篇笔记的第三段改写得更简洁」
  • 「根据这几篇笔记整理一份周报草稿」

关于写入 ​

当 Agent 需要修改或新建文件时,它不会直接落盘,而是先给你一个 diff。

  • 你可以在 diff 里逐处查看改动。
  • 确认后才会执行路径校验、hash 校验和原子写入。
  • 拒绝就什么都不会发生。

详见 写入确认机制。

可选:开启计划模式 ​

会话里可以打开「计划模式」。开启后 Agent 只用只读工具探索,先给出编号的执行计划,等你确认后才开始改文件。

适合「先看看它打算怎么做」的场景。

可选:接入 IM ​

在 设置 → 即时通讯 里配置飞书 / QQ / 微信 / 企业微信,就能在聊天里直接发起检索和写入请求。详见 即时通讯。

下一步 ​

基于 Apache-2.0 许可发布