司册 (Sice)
AI 原生的文档处理、知识管理和报告生成应用。
项目概述
司册是一款基于 AI 的文档智能处理平台,提供:
- 文档解析与结构化
- 知识库管理
- 智能报告生成
技术架构
C/S 架构系统,包含以下组件:
sice/
├── .claude/
│ ├── rules/ # 开发规范和规则文档
│ └── plans/ # 实现计划
│ ├── *.md # 进行中/待开始的计划
│ ├── completed/ # ✅ 已完成的计划
│ └── archived/ # 🗘️ 已废弃的计划
├── desktop/ # 桌面端应用 (Tauri v2)
├── packages/
│ └── agent-sdk/ # 原 TypeScript Vercel AI SDK 实现(保留备用)
├── agent/ # Python Agent (Deep Agents + FastAPI)
└── docs/
├── 01-design/ # 产品设计文档(PRD产品和功能设计、技术架构和实现规划设计)
│ ├── agent/ # Agent 架构设计
│ └── tauri/ # Tauri 端相关设计
├── 02-dev/ # 开发相关文档(技术说明、故障排除,开发环境,测试规范)
└── 10-archived/ # 🗘️ 已确认无用的过期文档归档技术选型
| 层级 | 技术栈 | 版本 | 说明 |
|---|---|---|---|
| 桌面端框架 | Tauri | v2.9+ | 轻量跨平台方案 |
| 前端框架 | React | 19.x | 最新稳定版 |
| UI 组件 | shadcn/ui | 4.x | 基于 Radix UI 的组件库 |
| AI 交互组件 | AI Elements | - | 基于 shadcn/ui 的 AI 聊天组件 |
| 样式方案 | Tailwind CSS | 4.x | 原子化 CSS |
| 状态管理 | Zustand | 5.x | 轻量状态管理 |
| Agent Harness | Deep Agents (Python) | - | Agent 编排框架(渐进式迁移中) |
| AI SDK | LangChain SDK | - | 前端调用 AI 能力的 SDK(useStream 实现) |
| 后端核心 | Rust | 1.77+ | Tauri 原生模块 |
| 服务端 | 待定 | - | - |
开发规范
代码风格
- TypeScript 为主要开发语言
- 使用 pnpm 作为包管理器
- 遵循 ESLint + Prettier 代码规范
Git 规范
详见 Git 提交规范
环境要求
- Node.js >= 20
- pnpm >= 9
- Rust >= 1.77(Tauri v2 要求)
系统依赖
Windows:
- Microsoft Visual Studio C++ Build Tools
- WebView2(Windows 10/11 已内置)
macOS:
- Xcode Command Line Tools:
xcode-select --install
Linux:
bash
sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev快速开始
bash
# 安装依赖
pnpm install
# 启动桌面端开发环境
pnpm tauri:dev
# 构建桌面端生产版本
pnpm tauri:build开发命令
常用命令
| 命令 | 说明 |
|---|---|
pnpm dev | 启动前端开发服务器(仅热更新) |
pnpm build | 构建前端生产版本 |
pnpm tauri:dev | 启动 Tauri 开发模式(前端 + Rust) |
pnpm tauri:build | 构建桌面端生产版本 |
pnpm type-check:desktop | TypeScript 类型检查 |
pnpm tauri <args> | 执行任意 tauri 命令 |
包管理命令
bash
# 为 desktop 包添加依赖
pnpm --filter sice-desktop add <package>
# 为 desktop 包添加开发依赖
pnpm --filter sice-desktop add -D <package>
# 查看所有包
pnpm list -r --depth 0构建命令
bash
# macOS ARM64
pnpm tauri build --target aarch64-apple-darwin
# macOS Intel
pnpm tauri build --target x86_64-apple-darwin
# Windows
pnpm tauri build --target x86_64-pc-windows-msvc故障排除
详见 docs/02-dev/故障排除.md(待补充)
开发优先级
- 主要开发平台: Windows、macOS
- 信创适配平台: 统信 UOS、银河麒麟(详见 信创兼容性规范)
注意事项
- 本项目使用中文作为主要文档语言
- 代码注释使用中文
- 提交信息使用中文或英文均可,但需遵循规范
技术文档
- 遇到 Deep Agents、LangChain、LangGraph 相关的 API 问题,获取参考示例,了解版本更新情况,必须使用
mcp__docs-langchain__search_docs_by_lang_chainMCP 工具查询官方文档,不能依赖记忆中的 API。 - 网页内容获取:优先使用Tavily Skills,替代WebFetch进行网页内容抓取