Documentation

5 分钟,上手 Nooko.Agent

从下载安装到多智能体协作,跟着步骤走一遍,本地即可跑通完整链路。

Quick Start

快速开始

三步走:下载客户端 → 配置模型密钥 → 开始对话。整个流程不超过 5 分钟。

下载并安装桌面客户端

前往 下载页面 选择对应平台安装包。Windows 推荐 .msi(含自动更新),macOS 选 .dmg,Linux 选 .AppImage 或 .deb。

💡 首次启动会创建本地加密 SQLite 数据库,密钥由你的系统账户派生(Argon2id + AES-256-GCM),无需额外配置。

配置模型 API Key(BYOK)

打开 设置 → 模型供应商,填入你的 API Key。Nooko.Agent 支持六大主流模型,至少配置一个即可开始。也可以选择 Ollama 本地模型,完全离线。

example · 供应商配置JSON
// 配置示例:OpenAI
{
  "provider": "openai",
  "apiKey": "sk-...",
  "baseUrl": "https://api.openai.com/v1",
  "models": ["gpt-4o", "gpt-4o-mini"]
}

// 配置示例:Ollama 本地
{
  "provider": "ollama",
  "baseUrl": "http://localhost:11434",
  "models": ["qwen2.5:7b", "llama3.2:8b"]
}

开启第一次对话

回到主界面,你的主 Agent 已经就绪。直接输入问题开始对话,所有数据本地加密存储。点击右上角的团队图标可以添加新的 Agent 成员。

✅ 至此你已经跑通基础链路。接下来可以尝试 RAG 知识库、可视化工作流、多 Agent 协作等进阶能力。
BYOK

配置模型密钥

Nooko.Agent 采用 BYOK(Bring Your Own Key)模式,密钥本地加密存储,不与任何人共享。

支持的供应商

OpenAI、Anthropic Claude、Google Gemini、DeepSeek、通义千问、Ollama(本地)。每个供应商支持自定义 baseUrl,可对接代理或自建网关。

密钥安全

所有 API Key 使用 Argon2id 从你的主密码派生密钥,再用 AES-256-GCM 对称加密存储在 byok_keys 表中。即使数据库文件被复制,没有主密码也无法解密。

智能模型路由

设置 → 模型路由 中配置策略:

  • cost:优先选择单位 token 价格最低的模型
  • latency:优先选择响应最快的模型
  • availability:自动剔除最近故障的模型
  • priority:按你设定的优先级顺序

FallbackChain 会在主模型故障时自动切换到备选,无需手动干预。

💡 提示:Ollama 完全本地运行,无需 API Key,适合隐私敏感场景。下载地址:ollama.com
RAG

搭建 RAG 知识库

把你的文档变成 Agent 可检索的知识。

创建知识库

知识库 页面点击"新建",命名并选择可见范围(个人 / 团队 / 企业)。

上传文档

支持 PDF、Markdown、TXT、DOCX 等格式。系统会自动分块(chunk)并生成 Embedding 向量,存入 chunk_embeddingsvss 表。

💡 无 API Key 时会回退到伪向量模式,依然能跑通检索链路,便于本地测试。

在对话中引用

对话时通过 @知识库名 引用,或在工作流中使用 knowledge_base 工具节点。回答会附带来源引用。

Workflow

编排可视化工作流

把复杂任务拆成节点,像搭积木一样串成流水线。

节点类型

  • LLM 调用:调用大模型生成回答
  • 工具调用:web_search / calculator / code_executor 等
  • 条件分支:根据上一步输出选择路径
  • 循环:重复执行直到满足条件
  • 知识库检索:RAG 查询节点

执行与调试

每个工作流支持版本管理,执行记录可回放查看每一步的输入输出。沙箱执行器(workflow-sandbox.service)隔离运行,避免污染主环境。

模板复用

常用工作流可保存为模板,团队共享。内置模板市场提供 PR 评审、客服工单、报表生成等开箱即用方案。

Multi-Agent

组建 Agent 团队

让多个 Agent 分工协作,处理复杂任务。

主 Agent

每位用户的首个 Agent 自动标记为主 Agent,作为协调者接收所有用户输入,并按需委派子任务给团队成员。

团队成员

Command Center 页面添加成员 Agent,为每个成员配置角色、工具子集、知识库权限。成员之间通过 agent_messages 消息总线异步通信。

@提及机制

对话中使用 @all 广播给全部成员,@成员名 指定单个成员。主 Agent 会汇总各成员的回复并整合输出。

💡 典型团队配置:研究员(web_search + knowledge_base)+ 写作员(LLM)+ 代码员(code_executor)+ 设计员(image_generator)
Architecture

技术架构

三端一体,monorepo 统一工程。

nooko-agent · 目录结构text
nooko-agent/
├── apps/
│   ├── desktop/      # Tauri 2 桌面端(Rust + React 19)
│   ├── server/       # NestJS 11 云端服务(Fastify)
│   └── admin/        # React 19 管理后台
├── packages/
│   ├── llm/          # 六大 Provider 抽象 + ModelRouter
│   ├── store/        # Zustand 状态管理
│   ├── api-client/   # 前后端 API 客户端
│   ├── ui/           # 共享 UI 组件库
│   ├── i18n/         # 30+ 语种国际化
│   └── types/        # 共享 TypeScript 类型
├── src-tauri/        # Rust 后端 + 工具注册表
└── docker-compose.yml

技术栈一览

  • 桌面前端:React 19 + Vite 6 + TypeScript 5.9 + Tailwind 4 + Zustand 5 + TanStack Query + React Router 7
  • 桌面外壳:Tauri 2(Rust),rusqlite(SQLCipher 加密)、argon2、aes-gcm、rsa、tokio、tokio-tungstenite
  • 云端服务:NestJS 11(Fastify)+ Drizzle ORM + Socket.IO + JWT/Passport + SAML SSO + Stripe + web-push + prom-client + Swagger
  • 数据库:PostgreSQL 16(云端,174 表)+ per-user 加密 SQLite(本地)
  • 缓存/队列:Redis 7(连接失败回退内存)
  • 对象存储:MinIO / AWS S3 双 Provider
  • 构建/质量:pnpm 10、Vite、tsc、drizzle-kit、cargo、Docker、Playwright(E2E)、Vitest、Jest、ESLint、Prettier、GitHub Actions
Self-Hosted

私有化部署

docker-compose 一键拉起全套服务,数据完全在内网。

docker-compose · 一键部署bash
# 1. 克隆仓库
git clone https://github.com/nooko/agent.nooko.git
cd agent.nooko/nooko-agent

# 2. 复制环境变量模板并修改
cp .env.example .env
# 编辑 .env:数据库密码、JWT 密钥、Stripe Key 等

# 3. 一键启动全套服务
docker-compose up -d

# 服务列表:
# - postgres    PostgreSQL 16
# - redis       Redis 7
# - minio       MinIO 对象存储
# - server      NestJS 云端服务
# - admin       管理后台

# 4. 初始化数据库 schema
docker-compose exec server pnpm db:migrate

# 5. 访问
# 管理后台  http://your-host:3003
# API 服务  http://your-host:3001/api
💡 企业版客户可联系销售获取部署白皮书,含 SSO 对接、负载均衡、备份策略、监控告警等生产级配置指南。
Developer API

API 集成

通过 API Key 与 Webhook 把 Nooko.Agent 能力接入你的系统。

REST API · 发起对话bash
curl -X POST https://your-host/api/chat/completions \
  -H "Authorization: Bearer nk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "agt_main",
    "messages": [
      {"role": "user", "content": "总结今天的产品会议"}
    ],
    "stream": true
  }'

认证

所有 API 请求需在 Header 中携带 Authorization: Bearer <api_key>。API Key 可在管理后台创建,支持配置 scopes(细粒度权限)与过期时间,可随时撤销。

Webhook

配置 Webhook 后,关键事件(对话完成、工作流执行、积分变动等)会以 HTTP POST 推送到你的回调地址,支持 HMAC 签名验证。

完整文档

云端服务内置 Swagger,部署后访问 http://your-host/api/docs 即可查看交互式 API 文档,支持在线调试。

FAQ

常见问题

桌面端:Windows 10+ / macOS 11+ / Ubuntu 20.04+,4GB 内存起步(本地模型建议 16GB+)。服务端:Docker 20+,4 核 CPU / 8GB 内存 / 50GB 磁盘。

桌面端:本地加密 SQLite(per-user,AES-256-GCM)。云端版:PostgreSQL 16。私有化部署:数据完全在你自己的服务器,不与任何人共享。

支持。配置 Ollama 本地模型后,整个对话、RAG、工作流链路可完全离线运行,零字节外发。适合隐私敏感场景。

桌面端内置自动更新,新版本发布后会提示一键升级。私有化部署通过 docker-compose pull && docker-compose up -d 升级,schema 变更通过 pnpm db:migrate 自动迁移。

免费版用户通过 GitHub Issues 与社区获取支持;专业版享受优先邮件支持;企业版有专属技术支持与 SLA 保障。详见 定价方案

可以。monorepo 结构清晰,packages/* 可独立复用。工具注册表支持动态注册自定义工具,工作流节点可扩展。企业版客户提供源码授权与定制开发服务。

准备好开始了吗?

下载客户端,跟着文档 5 分钟跑通第一个智能体。