# Routine

**Repository Path**: liuxbai/routine

## Basic Information

- **Project Name**: Routine
- **Description**: Routine 是一个运行在 macOS（Intel x86_64）上的**操作系统级 AI 助手**桌面应用。它通过多个专职 Agent 帮你完成日常事务：文件检索、系统控制、联网搜索、浏览器自动化，并支持定时任务自动执行。
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-29
- **Last Updated**: 2026-08-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Routine

Routine 是一个运行在 macOS（Intel x86_64）上的**操作系统级 AI 助手**桌面应用。它通过多个专职 Agent 帮你完成日常事务：文件检索、系统控制、联网搜索、浏览器自动化，并支持定时任务自动执行。

## ✨ 功能特性

### 🤖 多 Agent 编排
- **主 Agent**：统一 JSON 协议编排子工具，与 LLM 供应商无关
- **文件 Agent**：本地文件索引与全文搜索（默认索引 `~/Desktop`、`~/Documents`、`~/Downloads`）
- **系统 Agent**：操作系统级控制（快照、亮度、暗色模式等），基于白名单操作集
- **搜索 Agent**：联网搜索（支持 DuckDuckGo / Tavily）
- **浏览器 Agent**：基于 Playwright 的浏览器自动化，可用自然语言下达指令

### ☁️ LLM 双模式
- **云端模式**：任意 OpenAI 兼容 API（默认配置为智谱 GLM）
- **本地模式**：Ollama 本地模型（默认 `qwen2.5:3b`），保护隐私、离线可用

### 🛡️ 安全门机制
- 系统操作按风险分级（safe / medium / high）
- `medium` / `high` 风险操作（如 `empty-trash`、`kill-app`）必须经 UI 弹窗确认后才会执行

### ⏰ 定时任务（Todo Scheduler）
- 支持 `daily` / `weekly` / `monthly` / `anytime` 四种循环类型
- 到点自动将任务指令交给 Agent 执行，并记录运行历史
- 错过时间点后 24 小时内自动补跑（catch-up）

### 💬 对话界面
- 多会话管理、Markdown 渲染（GFM）
- 实时流式输出、Agent 状态面板、运行日志
- 会话与设置持久化（userData 目录下 JSON 文件，无原生模块依赖）

## 🏗️ 技术栈

| 层 | 技术 |
|----|------|
| 框架 | Electron 44 + TypeScript 5.9（严格模式） |
| 渲染层 | React 19 + Vite + Zustand |
| 主进程 | tsc 编译为 CJS |
| 文件监听 | chokidar |
| 浏览器自动化 | playwright-core |
| 打包 | electron-builder（macOS dmg / zip，x64） |

## 📁 项目结构

```
Routine/
├── src/
│   ├── main/              # Electron 主进程
│   │   ├── llm/           # LLM 路由（云端/本地双模式）
│   │   ├── agent/         # 编排器 + 安全门
│   │   ├── services/      # 文件索引、系统控制、搜索、浏览器、调度器、存储
│   │   ├── util/          # 路径展开、shell 工具
│   │   ├── ipc.ts         # IPC 装配
│   │   ├── preload.ts     # 预加载脚本
│   │   └── index.ts       # 入口
│   ├── renderer/          # 渲染层（React UI）
│   │   ├── components/    # 聊天视图、Agent 面板、设置页、安全确认弹窗等
│   │   └── store.ts       # Zustand 状态管理
│   └── shared/            # 冻结的共享类型与 IPC 通道定义
├── scripts/               # 开发与工具脚本
├── CONTRACTS.md           # 模块契约文档（目录所有权、IPC 协议）
└── electron-builder.yml   # 打包配置
```

详细架构契约见 [CONTRACTS.md](./CONTRACTS.md)。

## 🚀 快速开始

### 环境要求

- macOS 15+（Intel x86_64）
- Node.js v24+
- （可选，本地模式）[Ollama](https://ollama.com/)

### 开发运行

```bash
# 安装依赖
npm install

# 开发模式（带热重载）
npm run dev

# 或直接启动
npm start
```

### 生产构建与打包

```bash
# 编译 + 打包为 macOS x64 应用（输出到 release/）
npm run package
```

产出 `release/` 目录下的 `.dmg` 与 `.zip` 安装包。

## ⚙️ 配置说明

首次启动后进入 **设置页** 配置：

| 配置项 | 说明 |
|--------|------|
| LLM 模式 | `cloud`（云端）或 `local`（Ollama 本地） |
| 云端 API | baseURL / apiKey / model（任意 OpenAI 兼容接口） |
| Ollama | baseURL（默认 `http://localhost:11434`）/ model |
| 搜索源 | `duckduckgo`（免 key）或 `tavily`（需 API Key） |
| 索引目录 | 文件 Agent 扫描的目录列表，支持 `~` 展开 |
| 排除规则 | glob 模式，如 `node_modules/**`、`**/*.dmg` |

配置持久化在 `~/Library/Application Support/Routine/` 下的 JSON 文件中。

## 📡 IPC 架构

渲染层与主进程通过类型安全的 IPC 通道通信（定义在 `src/shared/ipc.ts`）：

- **invoke**（渲染层 → 主进程）：`chat:send`、`file:search`、`computer:exec`、`search:web`、`browser:run` 等
- **事件**（主进程 → 渲染层）：`chat:delta`（流式输出）、`agent:status`（Agent 状态）、`safety:request`（安全确认）、`index:progress`（索引进度）等

## 📄 License

Apache License 2.0