Familiars 官方文档

欢迎来到 Familiars —— Windows-first 多 Agent AI 桌面应用。 你可以先看 快速开始，或直接进入你想了解的章节。

---

📁 六大栏目

栏目	内容	适合谁
🚀 快速开始	安装、五分钟上手、界面导览、FAQ	所有新用户
📖 用户手册	完整操作手册（界面/对话/语音/数字人/工坊/流引擎）	日常使用者
🏗️ 架构剖析	从系统总览到数字人的技术架构解析（10 章）	技术爱好者 / 开发者
💻 开发指南	环境搭建、CLI 命令、Bridge API、内部开发指南	二次开发者
🧩 生态开发	Recipe / Flow / Broker 开发教程	生态贡献者
🔐 参考与安全	安全模型、仓库索引、团队规范	所有人 / 管理员

所有内容均来自官方仓库的文档体系，VitePress 自动生成，与主站同源。

---

🔎 快速导航

新手入门

• 安装指南 — Windows 一键安装 / 源码运行 / Docker Relay
• 五分钟上手 — 第一个 Agent → 第一次对话 → 第一个 Todo → 看到记忆
• 界面导览 — 走一遍所有主界面，了解每块功能在哪
• 常见问题 — 安装/使用/模型/隐私相关速答

进阶使用

• 完整操作手册 — 每个功能"在哪儿、点什么、按什么键"
• 工坊使用指南 — 创意工坊 / 技能工坊 / 交换所工坊
• 管线 · 流引擎 — 数据库迁移 / 多 Agent 管线 / Flow 运维

开发者

• CLI 全量命令 — 39 命令组 200+ 子命令，驱动整个 Bridge
• Bridge REST API — 46 路由文件，完整的 REST 接口
• Recipe 开发 — 单技能自动化配方
• Flow 开发 — 跨 Agent 流程编排
• Broker 开发 — 可分享的应用包

参考

• 安全模型 — 隐私设计、审批门控、敏感数据脱敏
• 仓库索引 — 代码结构与贡献规范
• 团队规范 — Claude 协作规范

---

🎬 视频

视频目录正在建设中，后续将在此挂载：

• 宣传短视频（30~60s，首页 Hero 自动播放）
• 技术架构长视频（对应 architecture/ 各篇）
• 演示操作长视频（对应 manual/ — 操作演示）
• Recipe / Flow / Broker 开发教学视频（对应 ecosystem/ 各篇）

---

📦 技术栈一览

层	技术
前端	Electron + Vue 3 + Vite + TypeScript + Pinia
后端	FastAPI + Hypercorn (HTTP/2) + SQLite WAL
AI	OpenAI 兼容 LLM · bge-m3 向量 · QLoRA 本地小模型
语音	GPT-SoVITS · faster-whisper ASR
生态	Recipe (技能图) · Flow (工作流) · Broker (应用包) · Marketplace

---

文末：本文档由官方维护，如有误或缺失请通过 反馈 提交。