Corivo AGENTS.md

AGENTS.md

This file provides guidance to Codex (Codex.ai/code) when working with code in this repository.

项目概述

Corivo 是一个融入用户已有工作流的赛博伙伴。它不是一个独立的 App，而是寄生在 Codex、Cursor、飞书等工具中的后台服务——自动从用户的 AI 对话和消息中采集信息，持续整理和更新，在合适的时机以 [corivo] 的名义主动提醒用户。

当前版本请以各 package 的 package.json 为准（workspace 内版本独立演进）

详细设计文档见 README.md

---

Package 文档

相关 package 的本地开发说明分散在各自文档中：

• packages/cli/README.md — CLI 工具、数据库、心跳引擎
• packages/solver/README.md — CRDT 同步服务器
• packages/plugins/codex/README.md — Codex plugin root（当前以主机侧集成资产为主）
• packages/plugins/claude-code/README.md — Claude Code plugin root
• packages/plugins/cursor/README.md — Cursor plugin root
• packages/plugins/opencode/README.md — OpenCode plugin root（同时包含安装资产与运行时代码）
• packages/plugins/openclaw/README.md — OpenClaw plugin root（运行时代码）

进入某个 package 工作时，优先阅读该 package 的本地说明文档。

plugins 目录边界（必须遵守）

• packages/plugins/<plugin>：按插件名组织。每个插件目录放这个插件实际需要的 assets、runtime code、scripts、templates、README。
• 插件内部仍要保持职责清晰：主机安装资产、可执行运行时代码、构建脚本不要混成无边界的大杂烩。
• 安装入口保持单一路径：通过 corivo host install（或 scripts/install.sh 委托到 CLI）完成，不在插件包内扩展第二套安装逻辑。

---

构建与测试（快速参考）

每个 package 独立管理，进入对应目录后操作：

# packages/cli
cd packages/cli
npm run build          # tsdown
npm run dev            # tsdown --watch
npm run test           # vitest --run

# packages/solver
cd packages/solver
npm run dev            # tsx watch src/index.ts（开发热重载）
npm run build          # tsc
npm run start          # node dist/index.js

# packages/plugins/codex
cd packages/plugins/codex
# 配置/文档型 package，无独立构建步骤

测试（当前以 cli package 的 Vitest 套件最完整）：

cd packages/cli
# 运行所有测试
npm run test

# 运行单个测试文件
npm run test -- __tests__/unit/database.test.ts
npm run test -- __tests__/integration/heartbeat.test.ts
npm run test -- __tests__/integration/claude-code-ingestor.test.ts