# cocoindex - Doramagic AI Context Pack

> 定位：安装前体验与判断资产。它帮助宿主 AI 有一个好的开始，但不代表已经安装、执行或验证目标项目。

## 充分原则

- **充分原则，不是压缩原则**：AI Context Pack 应该充分到让宿主 AI 在开工前理解项目价值、能力边界、使用入口、风险和证据来源；它可以分层组织，但不以最短摘要为目标。
- **压缩策略**：只压缩噪声和重复内容，不压缩会影响判断和开工质量的上下文。

## 给宿主 AI 的使用方式

你正在读取 Doramagic 为 cocoindex 编译的 AI Context Pack。请把它当作开工前上下文：帮助用户理解适合谁、能做什么、如何开始、哪些必须安装后验证、风险在哪里。不要声称你已经安装、运行或执行了目标项目。

## Claim 消费规则

- **事实来源**：Repo Evidence + Claim/Evidence Graph；Human Wiki 只提供显著性、术语和叙事结构。
- **事实最低状态**：`supported`
- `supported`：可以作为项目事实使用，但回答中必须引用 claim_id 和证据路径。
- `weak`：只能作为低置信度线索，必须要求用户继续核实。
- `inferred`：只能用于风险提示或待确认问题，不能包装成项目事实。
- `unverified`：不得作为事实使用，应明确说证据不足。
- `contradicted`：必须展示冲突来源，不得替用户强行选择一个版本。

## 它最适合谁

- **正在使用 Claude/Codex/Cursor/Gemini 等宿主 AI 的开发者**：README 或插件配置提到多个宿主 AI。 证据：`README.md` Claim：`clm_0003` supported 0.86
- **希望把专业流程带进宿主 AI 的用户**：仓库包含 Skill 文档。 证据：`dev/agent-skills/cocoindex-diagrams/SKILL.md`, `dev/agent-skills/target-connector/SKILL.md`, `dev/agent-skills/upgrade-examples/SKILL.md` Claim：`clm_0004` supported 0.86

## 它能做什么

- **AI Skill / Agent 指令资产库**（可做安装前预览）：项目包含可被宿主 AI 读取的 Skill 或 Agent 指令文件，可用于把专业流程带入 Claude、Codex、Cursor 等宿主。 证据：`dev/agent-skills/cocoindex-diagrams/SKILL.md`, `dev/agent-skills/target-connector/SKILL.md`, `dev/agent-skills/upgrade-examples/SKILL.md` Claim：`clm_0001` supported 0.86
- **命令行启动或安装流程**（需要安装后验证）：项目文档中存在可执行命令，真实使用需要在本地或宿主环境中运行这些命令。 证据：`README.md` Claim：`clm_0002` supported 0.86

## 怎么开始

- `pip install -U cocoindex` 证据：`README.md` Claim：`clm_0005` supported 0.86

## 继续前判断卡

- **当前建议**：仅建议沙盒试装
- **为什么**：项目存在安装命令、宿主配置或本地写入线索，不建议直接进入主力环境，应先在隔离环境试装。

### 30 秒判断

- **现在怎么做**：仅建议沙盒试装
- **最小安全下一步**：先跑 Prompt Preview；若仍要安装，只在隔离环境试装
- **先别相信**：真实输出质量不能在安装前相信。
- **继续会触碰**：命令执行、宿主 AI 配置、本地环境或项目文件

### 现在可以相信

- **适合人群线索：正在使用 Claude/Codex/Cursor/Gemini 等宿主 AI 的开发者**（supported）：有 supported claim 或项目证据支撑，但仍不等于真实安装效果。 证据：`README.md` Claim：`clm_0003` supported 0.86
- **适合人群线索：希望把专业流程带进宿主 AI 的用户**（supported）：有 supported claim 或项目证据支撑，但仍不等于真实安装效果。 证据：`dev/agent-skills/cocoindex-diagrams/SKILL.md`, `dev/agent-skills/target-connector/SKILL.md`, `dev/agent-skills/upgrade-examples/SKILL.md` Claim：`clm_0004` supported 0.86
- **能力存在：AI Skill / Agent 指令资产库**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`dev/agent-skills/cocoindex-diagrams/SKILL.md`, `dev/agent-skills/target-connector/SKILL.md`, `dev/agent-skills/upgrade-examples/SKILL.md` Claim：`clm_0001` supported 0.86
- **能力存在：命令行启动或安装流程**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`README.md` Claim：`clm_0002` supported 0.86
- **存在 Quick Start / 安装命令线索**（supported）：可以相信项目文档出现过启动或安装入口；不要因此直接在主力环境运行。 证据：`README.md` Claim：`clm_0005` supported 0.86

### 现在还不能相信

- **真实输出质量不能在安装前相信。**（unverified）：Prompt Preview 只能展示引导方式，不能证明真实项目中的结果质量。
- **宿主 AI 版本兼容性不能在安装前相信。**（unverified）：Claude、Cursor、Codex、Gemini 等宿主加载规则和版本差异必须在真实环境验证。
- **不会污染现有宿主 AI 行为，不能直接相信。**（inferred）：Skill、plugin、AGENTS/CLAUDE/GEMINI 指令可能改变宿主 AI 的默认行为。 证据：`AGENTS.md`, `CLAUDE.md`, `dev/agent-skills/cocoindex-diagrams/SKILL.md`, `dev/agent-skills/target-connector/SKILL.md` 等
- **可安全回滚不能默认相信。**（unverified）：除非项目明确提供卸载和恢复说明，否则必须先在隔离环境验证。
- **真实安装后是否与用户当前宿主 AI 版本兼容？**（unverified）：兼容性只能通过实际宿主环境验证。
- **项目输出质量是否满足用户具体任务？**（unverified）：安装前预览只能展示流程和边界，不能替代真实评测。
- **安装命令是否需要网络、权限或全局写入？**（unverified）：这影响企业环境和个人环境的安装风险。 证据：`README.md`

### 继续会触碰什么

- **命令执行**：包管理器、网络下载、本地插件目录、项目配置或用户主目录。 原因：运行第一条命令就可能产生环境改动；必须先判断是否值得跑。 证据：`README.md`
- **宿主 AI 配置**：Claude/Codex/Cursor/Gemini/OpenCode 等宿主的 plugin、Skill 或规则加载配置。 原因：宿主配置会改变 AI 后续工作方式，可能和用户已有规则冲突。 证据：`AGENTS.md`, `CLAUDE.md`, `dev/agent-skills/cocoindex-diagrams/SKILL.md`, `dev/agent-skills/target-connector/SKILL.md` 等
- **本地环境或项目文件**：安装结果、插件缓存、项目配置或本地依赖目录。 原因：安装前无法证明写入范围和回滚方式，需要隔离验证。 证据：`README.md`
- **宿主 AI 上下文**：AI Context Pack、Prompt Preview、Skill 路由、风险规则和项目事实。 原因：导入上下文会影响宿主 AI 后续判断，必须避免把未验证项包装成事实。

### 最小安全下一步

- **先跑 Prompt Preview**：用安装前交互式试用判断工作方式是否匹配，不需要授权或改环境。（适用：任何项目都适用，尤其是输出质量未知时。）
- **只在隔离目录或测试账号试装**：避免安装命令污染主力宿主 AI、真实项目或用户主目录。（适用：存在命令执行、插件配置或本地写入线索时。）
- **先备份宿主 AI 配置**：Skill、plugin、规则文件可能改变 Claude/Cursor/Codex 的默认行为。（适用：存在插件 manifest、Skill 或宿主规则入口时。）
- **安装后只验证一个最小任务**：先验证加载、兼容、输出质量和回滚，再决定是否深用。（适用：准备从试用进入真实工作流时。）

### 退出方式

- **保留安装前状态**：记录原始宿主配置和项目状态，后续才能判断是否可恢复。
- **准备移除宿主 plugin / Skill / 规则入口**：如果试装后行为异常，可以把宿主 AI 恢复到试装前状态。
- **记录安装命令和写入路径**：没有明确卸载说明时，至少要知道哪些目录或配置需要手动清理。
- **如果没有回滚路径，不进入主力环境**：不可回滚是继续前阻断项，不应靠信任或运气继续。

## 哪些只能预览

- 解释项目适合谁和能做什么
- 基于项目文档演示典型对话流程
- 帮助用户判断是否值得安装或继续研究

## 哪些必须安装后验证

- 真实安装 Skill、插件或 CLI
- 执行脚本、修改本地文件或访问外部服务
- 验证真实输出质量、性能和兼容性

## 边界与风险判断卡

- **把安装前预览误认为真实运行**：用户可能高估项目已经完成的配置、权限和兼容性验证。 处理方式：明确区分 prompt_preview_can_do 与 runtime_required。 Claim：`clm_0006` inferred 0.45
- **命令执行会修改本地环境**：安装命令可能写入用户主目录、宿主插件目录或项目配置。 处理方式：先在隔离环境或测试账号中运行。 证据：`README.md` Claim：`clm_0007` supported 0.86
- **待确认**：真实安装后是否与用户当前宿主 AI 版本兼容？。原因：兼容性只能通过实际宿主环境验证。
- **待确认**：项目输出质量是否满足用户具体任务？。原因：安装前预览只能展示流程和边界，不能替代真实评测。
- **待确认**：安装命令是否需要网络、权限或全局写入？。原因：这影响企业环境和个人环境的安装风险。

## 开工前工作上下文

### 加载顺序

- 先读取 how_to_use.host_ai_instruction，建立安装前判断资产的边界。
- 读取 claim_graph_summary，确认事实来自 Claim/Evidence Graph，而不是 Human Wiki 叙事。
- 再读取 intended_users、capabilities 和 quick_start_candidates，判断用户是否匹配。
- 需要执行具体任务时，优先查 role_skill_index，再查 evidence_index。
- 遇到真实安装、文件修改、网络访问、性能或兼容性问题时，转入 risk_card 和 boundaries.runtime_required。

### 任务路由

- **AI Skill / Agent 指令资产库**：先基于 role_skill_index / evidence_index 帮用户挑选可用角色、Skill 或工作流。 边界：可做安装前 Prompt 体验。 证据：`dev/agent-skills/cocoindex-diagrams/SKILL.md`, `dev/agent-skills/target-connector/SKILL.md`, `dev/agent-skills/upgrade-examples/SKILL.md` Claim：`clm_0001` supported 0.86
- **命令行启动或安装流程**：先说明这是安装后验证能力，再给出安装前检查清单。 边界：必须真实安装或运行后验证。 证据：`README.md` Claim：`clm_0002` supported 0.86

### 上下文规模

- 文件总数：901
- 重要文件覆盖：40/901
- 证据索引条目：80
- 角色 / Skill 条目：3

### 证据不足时的处理

- **missing_evidence**：说明证据不足，要求用户提供目标文件、README 段落或安装后验证记录；不要补全事实。
- **out_of_scope_request**：说明该任务超出当前 AI Context Pack 证据范围，并建议用户先查看 Human Manual 或真实安装后验证。
- **runtime_request**：给出安装前检查清单和命令来源，但不要替用户执行命令或声称已执行。
- **source_conflict**：同时展示冲突来源，标记为待核实，不要强行选择一个版本。

## Prompt Recipes

### 适配判断

- 目标：判断这个项目是否适合用户当前任务。
- 预期输出：适配结论、关键理由、证据引用、安装前可预览内容、必须安装后验证内容、下一步建议。

```text
请基于 cocoindex 的 AI Context Pack，先问我 3 个必要问题，然后判断它是否适合我的任务。回答必须包含：适合谁、能做什么、不能做什么、是否值得安装、证据来自哪里。所有项目事实必须引用 evidence_refs、source_paths 或 claim_id。
```

### 安装前体验

- 目标：让用户在安装前感受核心工作流，同时避免把预览包装成真实能力或营销承诺。
- 预期输出：一段带边界标签的体验剧本、安装后验证清单和谨慎建议；不含真实运行承诺或强营销表述。

```text
请把 cocoindex 当作安装前体验资产，而不是已安装工具或真实运行环境。

请严格输出四段：
1. 先问我 3 个必要问题。
2. 给出一段“体验剧本”：用 [安装前可预览]、[必须安装后验证]、[证据不足] 三种标签展示它可能如何引导工作流。
3. 给出安装后验证清单：列出哪些能力只有真实安装、真实宿主加载、真实项目运行后才能确认。
4. 给出谨慎建议：只能说“值得继续研究/试装”“先补充信息后再判断”或“不建议继续”，不得替项目背书。

硬性边界：
- 不要声称已经安装、运行、执行测试、修改文件或产生真实结果。
- 不要写“自动适配”“确保通过”“完美适配”“强烈建议安装”等承诺性表达。
- 如果描述安装后的工作方式，必须使用“如果安装成功且宿主正确加载 Skill，它可能会……”这种条件句。
- 体验剧本只能写成“示例台词/假设流程”：使用“可能会询问/可能会建议/可能会展示”，不要写“已写入、已生成、已通过、正在运行、正在生成”。
- Prompt Preview 不负责给安装命令；如用户准备试装，只能提示先阅读 Quick Start 和 Risk Card，并在隔离环境验证。
- 所有项目事实必须来自 supported claim、evidence_refs 或 source_paths；inferred/unverified 只能作风险或待确认项。

```

### 角色 / Skill 选择

- 目标：从项目里的角色或 Skill 中挑选最匹配的资产。
- 预期输出：候选角色或 Skill 列表，每项包含适用场景、证据路径、风险边界和是否需要安装后验证。

```text
请读取 role_skill_index，根据我的目标任务推荐 3-5 个最相关的角色或 Skill。每个推荐都要说明适用场景、可能输出、风险边界和 evidence_refs。
```

### 风险预检

- 目标：安装或引入前识别环境、权限、规则冲突和质量风险。
- 预期输出：环境、权限、依赖、许可、宿主冲突、质量风险和未知项的检查清单。

```text
请基于 risk_card、boundaries 和 quick_start_candidates，给我一份安装前风险预检清单。不要替我执行命令，只说明我应该检查什么、为什么检查、失败会有什么影响。
```

### 宿主 AI 开工指令

- 目标：把项目上下文转成一次对话开始前的宿主 AI 指令。
- 预期输出：一段边界明确、证据引用明确、适合复制给宿主 AI 的开工前指令。

```text
请基于 cocoindex 的 AI Context Pack，生成一段我可以粘贴给宿主 AI 的开工前指令。这段指令必须遵守 not_runtime=true，不能声称项目已经安装、运行或产生真实结果。
```

## 角色 / Skill 索引

- 共索引 3 个角色 / Skill / 项目文档条目。

- **cocoindex-diagrams**（skill）：This skill should be used when creating, editing, or reviewing inline SVG diagrams for the CocoIndex docs site anything under docs/src/content/docs/ . It encodes the component-based primitive system under docs/src/components/diagrams/, the palette + shape semantics, the preview-and-verify loop using headless Chrome with the /docs base path, and the pitfalls that cost iterations to discover. Trigger phrases include "… 激活提示：当用户任务与“cocoindex-diagrams”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`dev/agent-skills/cocoindex-diagrams/SKILL.md`
- **target-connector**（skill）：This skill should be used when creating a new target connector for CocoIndex to integrate with external systems. It provides guidance on implementing TargetHandler, TargetActionSink, and related types for declarative target state synchronization with change detection and automatic cleanup. 激活提示：当用户任务与“target-connector”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`dev/agent-skills/target-connector/SKILL.md`
- **upgrade-examples**（skill）：This skill should be used when upgrading the cocoindex package version in all example pyproject.toml files. It uses regex-based sed commands to efficiently update version constraints across multiple files at once. 激活提示：当用户任务与“upgrade-examples”描述的流程高度相关时，先用它做安装前体验，再决定是否安装。 证据：`dev/agent-skills/upgrade-examples/SKILL.md`

## 证据索引

- 共索引 80 条证据。

- **Docs Diagrams**（documentation）：Inline, componentized SVG diagrams for the docs site. This directory is the single source of truth for any diagram embedded in docs pages — old /public/img/ / .svg files should be treated as legacy and replaced here over time. 证据：`docs/src/components/diagrams/README.md`
- **Readme**（documentation）：Star us ❤️ →    ·   ·   ·  证据：`README.md`
- **Development Scripts**（documentation）：This directory contains development and maintenance scripts for the CocoIndex project. 证据：`dev/README.md`
- **Entity resolution benchmark**（documentation）：Synthetic benchmark for cocoindex.ops.entity resolution.resolve entities . 证据：`benchmarks/entity_resolution/README.md`
- **Rust SDK vs Python SDK — side-by-side benchmark**（documentation）：Rust SDK vs Python SDK — side-by-side benchmark 证据：`benchmarks/file_summarization/README.md`
- **Amazon S3 Embedding v1 🪣**（documentation）：This example embeds markdown files from an S3 bucket, stores the chunks + embeddings in Postgres pgvector , and provides a simple semantic-search query demo. 证据：`examples/amazon_s3_embedding/README.md`
- **Code Embedding with LanceDB v1**（documentation）：This example extracts code chunks from local Python, Rust, TOML, and Markdown files, stores the code and their vector embeddings in LanceDB, and provides a simple semantic search demo for code. 证据：`examples/code_embedding_lancedb/README.md`
- **How it works**（documentation）：Turn podcasts into a knowledge graph . 证据：`examples/conversation_to_knowledge/README.md`
- **CSV to Kafka**（documentation）：This example watches local CSV files, converts each row to a JSON object using the header row as keys , and publishes messages to a Kafka topic. When a CSV file is modified, only the changed rows are re-published. 证据：`examples/csv_to_kafka/README.md`
- **Build a Knowledge Graph for Docs — Neo4j CocoIndex v1**（documentation）：Build a Knowledge Graph for Docs — Neo4j CocoIndex v1 证据：`examples/docs_to_knowledge_graph/README.md`
- **Files Transform**（documentation）：This example watches a directory of local Markdown files, converts each one to HTML using markdown-it-py https://github.com/executablebooks/markdown-it-py , and writes the resulting .html files to an output folder. It runs in live mode, so it continues watching for file changes after the initial sync. 证据：`examples/files_transform/README.md`
- **Image Search with CocoIndex v1**（documentation）：Image Search with CocoIndex v1 ! GitHub https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6 https://github.com/cocoindex-io/cocoindex 证据：`examples/image_search/README.md`
- **Image Search with ColPali v1**（documentation）：Image Search with ColPali v1 ! GitHub https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6 https://github.com/cocoindex-io/cocoindex 证据：`examples/image_search_colpali/README.md`
- **Kafka to LanceDB**（documentation）：This example consumes JSON messages from a Kafka topic produced by the csv to kafka ../csv to kafka example and dispatches them to two LanceDB tables — products and employees — based on the message content. 证据：`examples/kafka_to_lancedb/README.md`
- **Build Meeting Notes Knowledge Graph from Google Drive — FalkorDB CocoIndex v1**（documentation）：Build Meeting Notes Knowledge Graph from Google Drive — FalkorDB CocoIndex v1 证据：`examples/meeting_notes_graph_falkordb/README.md`
- **Build Meeting Notes Knowledge Graph from Google Drive — Neo4j CocoIndex v1**（documentation）：Build Meeting Notes Knowledge Graph from Google Drive — Neo4j CocoIndex v1 证据：`examples/meeting_notes_graph_neo4j/README.md`
- **What It Does**（documentation）：Self-Updating Wiki for Your Codebases with LLM 证据：`examples/multi_codebase_summarization/README.md`
- **OCI Object Storage Embedding v1 ☁️**（documentation）：This example embeds markdown files from an Oracle Cloud Infrastructure OCI Object Storage bucket, stores the chunks + embeddings in Postgres pgvector , and provides a simple semantic-search query demo. 证据：`examples/oci_object_storage_embedding/README.md`
- **Extract structured data from patient intake forms with BAML v1**（documentation）：Extract structured data from patient intake forms with BAML v1 证据：`examples/patient_intake_extraction_baml/README.md`
- **Extract structured data from patient intake forms with DSPy v1**（documentation）：Extract structured data from patient intake forms with DSPy v1 证据：`examples/patient_intake_extraction_dspy/README.md`
- **Note:**（documentation）：Note: Example files here are purely artificial and not real, for testing purposes only. Please do not use these examples for any other purpose. 证据：`examples/patient_intake_extraction_dspy/data/README.md`
- **PDF to Markdown**（documentation）：This example walks a directory of local PDF files, converts each one to Markdown using docling https://github.com/DS4SD/docling , and writes the resulting .md files to an output folder. 证据：`examples/pdf_to_markdown/README.md`
- **Code Embedding with LanceDB Rust**（documentation）：Rust port of the Python code embedding lancedb ../../code embedding lancedb example. 证据：`examples/rust/code_embedding_lancedb/README.md`
- **Conversation to Knowledge Rust**（documentation）：Rust port of the Python conversation to knowledge ../../conversation to knowledge example. 证据：`examples/rust/conversation_to_knowledge/README.md`
- **CSV to Iggy Rust**（documentation）：Rust analogue of the Python csv to kafka ../../csv to kafka example, targeting Apache Iggy instead of Kafka. Python ships an iggy connector with the same shape as its kafka one; this mirrors the Rust csv to kafka ../csv to kafka example onto cocoindex::iggy . 证据：`examples/rust/csv_to_iggy/README.md`
- **CSV to Kafka Rust**（documentation）：Rust port of the Python csv to kafka ../../csv to kafka example. 证据：`examples/rust/csv_to_kafka/README.md`
- **Files → SQLite Rust**（documentation）：A self-contained example of the Rust SDK's embedded SQLite table target cocoindex::sqlite . No external server is needed — SQLite is embedded. 证据：`examples/rust/files_to_sqlite/README.md`
- **Files Transform**（documentation）：Rust equivalent of the Python files transform ../../files transform example. 证据：`examples/rust/files_transform/README.md`
- **Image search CLIP + Qdrant, Rust**（documentation）：Rust port of the Python image search ../../image search example. Embeds images with the CLIP ViT-B/32 vision tower and indexes them in Qdrant; queries embed text with the matching CLIP text tower same 512-dim space , so you can search images by natural language. 证据：`examples/rust/image_search/README.md`
- **Drop images here .jpg/.jpeg/.png/.webp/.gif/.bmp to index.**（documentation）：Drop images here .jpg/.jpeg/.png/.webp/.gif/.bmp to index. 证据：`examples/rust/image_search/img/README.md`
- **ColPali multi-vector image search Qdrant, Rust**（documentation）：ColPali multi-vector image search Qdrant, Rust 证据：`examples/rust/image_search_colpali/README.md`
- **Drop images here to index with ColPali.**（documentation）：Drop images here to index with ColPali. 证据：`examples/rust/image_search_colpali/img/README.md`
- **Kafka consume Rust**（documentation）：A self-contained example of the Rust SDK's native Kafka source cocoindex::kafka::topic as map + Ctx::mount each live — the analogue of Python's topic as map . Pairs with the csv to kafka ../csv to kafka target example: produce with that, consume with this. 证据：`examples/rust/kafka_consume/README.md`
- **Meeting Notes Graph — FalkorDB Rust**（documentation）：Meeting Notes Graph — FalkorDB Rust 证据：`examples/rust/meeting_notes_graph_falkordb/README.md`
- **Meeting Notes Graph — Neo4j Rust**（documentation）：Rust companion to the Python meeting notes graph neo4j ../../meeting notes graph neo4j example. 证据：`examples/rust/meeting_notes_graph_neo4j/README.md`
- **Multi-Codebase Summarization 📝**（documentation）：Rust equivalent of the Python multi codebase summarization ../../multi codebase summarization example. 证据：`examples/rust/multi_codebase_summarization/README.md`
- **PDF to Markdown Rust**（documentation）：Rust port of the Python pdf to markdown ../../pdf to markdown example. 证据：`examples/rust/pdf_to_markdown/README.md`
- **Text Embedding with LanceDB Rust**（documentation）：Rust port of the Python text embedding lancedb ../../text embedding lancedb example. Same pipeline as text embedding ../text embedding , but the vector store is LanceDB an embedded, file-based vector database via the native cocoindex::lancedb connector instead of Postgres/pgvector. 证据：`examples/rust/text_embedding_lancedb/README.md`
- **Text Embedding with Qdrant Rust**（documentation）：Rust port of the Python text embedding qdrant ../../text embedding qdrant example. 证据：`examples/rust/text_embedding_qdrant/README.md`
- **Text Embedding with Turbopuffer Rust**（documentation）：Text Embedding with Turbopuffer Rust 证据：`examples/rust/text_embedding_turbopuffer/README.md`
- **Text Embedding with LanceDB v1**（documentation）：This example embeds local markdown files, stores the chunks + embeddings in LanceDB, and provides a simple semantic-search query demo. 证据：`examples/text_embedding_lancedb/README.md`
- **Text Embedding with Qdrant v1 🔍**（documentation）：This example embeds local markdown files, stores the chunks + embeddings in Qdrant, and provides a simple semantic-search query demo. 证据：`examples/text_embedding_qdrant/README.md`
- **Text Embedding with Turbopuffer v1**（documentation）：This example embeds local markdown files, stores the chunks + embeddings in a Turbopuffer https://turbopuffer.com/ namespace, and provides a simple semantic-search query demo. 证据：`examples/text_embedding_turbopuffer/README.md`
- **cocoindex code match**（documentation）：Match by-example code patterns against tree-sitter ASTs , with metavariables. 证据：`rust/code_match/README.md`
- **CLI Test Examples**（documentation）：Test examples for CLI commands: ls , update , show , and drop . 证据：`python/tests/cli/README.md`
- **AGENTS.md**（documentation）：This file provides guidance to coding agents working with code in this repository. Claude Code compatibility is kept through CLAUDE.md , which imports this file. 证据：`AGENTS.md`
- **CLAUDE.md**（documentation）：CLAUDE.md @AGENTS.md 证据：`CLAUDE.md`
- **AGENTS.md — CocoIndex examples**（documentation）：Guidance for AI coding agents Claude Code, Cursor, etc. working in this examples/ directory. Most top-level Python subfolders are self-contained, runnable CocoIndex v1 apps; rust/ contains Rust ports with per-example READMEs. 证据：`examples/AGENTS.md`
- **Package**（package_manifest）：{ "name": "cocoindex-docs-astro", "type": "module", "version": "0.0.0", "private": true, "engines": { "node": " =22.12.0" }, "scripts": { "dev": "astro dev", "build": "astro build && node scripts/check-agent-output.mjs", "preview": "astro preview", "astro": "astro" }, "dependencies": { "@astrojs/mdx": "^5.0.3", "@astrojs/sitemap": "^3.7.2", "@cocoindex/brand": "github:cocoindex-io/cocoindex-brand v0.4.9", "@docsearch/css": "^4.6.2", "@docsearch/js": "^4.6.2", "astro": "^6.1.8", "mdast-util-to-string": "^4.0.0", "mermaid": "^11.15.0", "mixpanel-browser": "^2.78.0", "posthog-js": "^1.369.3", "remark-directive": "^4.0.0", "sharp": "^0.34.5", "unist-util-visit": "^5.0.0" }, "devDependencies": {… 证据：`docs/package.json`
- **Contributing**（documentation）：We love contributions from our community ❤️. Please check out our contributing guide https://cocoindex.io/docs/contributing/guide . 证据：`CONTRIBUTING.md`
- **Package**（package_manifest）：{ "name": "image-search-frontend", "version": "0.1.0", "private": true, "scripts": { "dev": "vite", "build": "vite build", "preview": "vite preview" }, "dependencies": { "react": "^18.2.0", "react-dom": "^18.2.0" }, "devDependencies": { "vite": "^7.3.2", "@vitejs/plugin-react": "^5.0.2" } } 证据：`examples/image_search/frontend/package.json`
- **Package**（package_manifest）：{ "name": "image-search-frontend", "version": "0.1.0", "private": true, "scripts": { "dev": "vite", "build": "vite build", "preview": "vite preview" }, "dependencies": { "react": "^18.2.0", "react-dom": "^18.2.0" }, "devDependencies": { "vite": "^7.1.5", "@vitejs/plugin-react": "^5.0.2" } } 证据：`examples/image_search_colpali/frontend/package.json`
- **CocoIndex Docs Diagrams**（skill_instruction）：Inline SVG diagrams in the docs are authored as Astro components under docs/src/components/diagrams/ , composed from shape-semantic primitives that share a palette and styling. Static .svg files exported from design tools are legacy — always build new diagrams with the primitives. 证据：`dev/agent-skills/cocoindex-diagrams/SKILL.md`
- **Target Connector**（skill_instruction）：A target connector connects CocoIndex's declarative target state system to external systems. It handles synchronization by determining what changed and applying changes to the external system. 证据：`dev/agent-skills/target-connector/SKILL.md`
- **Upgrade Example Dependencies**（skill_instruction）：Upgrade the cocoindex version in all example pyproject.toml files. 证据：`dev/agent-skills/upgrade-examples/SKILL.md`
- **License**（source_file）：Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ 证据：`LICENSE`
- **Flow overview**（documentation）：! CSV in, Kafka out — row by row, live, with CocoIndex https://cocoindex.io/blobs/docs-v1/img/examples/csv-to-kafka/cover.png 证据：`docs/src/content/example-posts/csv-to-kafka.md`
- **Use cases**（documentation）：! Turn documentation into a knowledge graph with LLM extraction and CocoIndex https://cocoindex.io/blobs/docs-v1/img/examples/docs-to-knowledge-graph/cover.png 证据：`docs/src/content/example-posts/docs-to-knowledge-graph.md`
- **Flow overview**（documentation）：! Index faces for visual search — build your own Google Photo face search with CocoIndex https://cocoindex.io/blobs/docs-v1/img/examples/face-recognition/cover.png 证据：`docs/src/content/example-posts/face-recognition.md`
- **Flow overview**（documentation）：! Transform a folder of files with CocoIndex V1 https://cocoindex.io/blobs/docs-v1/img/examples/files-transform/cover.png 证据：`docs/src/content/example-posts/files-transform.md`
- 其余 20 条证据见 `AI_CONTEXT_PACK.json` 或 `EVIDENCE_INDEX.json`。

## 宿主 AI 必须遵守的规则

- **把本资产当作开工前上下文，而不是运行环境。**：AI Context Pack 只包含证据化项目理解，不包含目标项目的可执行状态。 证据：`docs/src/components/diagrams/README.md`, `README.md`, `dev/README.md`
- **回答用户时区分可预览内容与必须安装后才能验证的内容。**：安装前体验的消费者价值来自降低误装和误判，而不是伪装成真实运行。 证据：`docs/src/components/diagrams/README.md`, `README.md`, `dev/README.md`

## 用户开工前应该回答的问题

- 你准备在哪个宿主 AI 或本地环境中使用它？
- 你只是想先体验工作流，还是准备真实安装？
- 你最在意的是安装成本、输出质量、还是和现有规则的冲突？

## 验收标准

- 所有能力声明都能回指到 evidence_refs 中的文件路径。
- AI_CONTEXT_PACK.md 没有把预览包装成真实运行。
- 用户能在 3 分钟内看懂适合谁、能做什么、如何开始和风险边界。

---

## Doramagic Context Augmentation

下面内容用于强化 Repomix/AI Context Pack 主体。Human Manual 只提供阅读骨架；踩坑日志会被转成宿主 AI 必须遵守的工作约束。

## Human Manual 骨架

使用规则：这里只是项目阅读路线和显著性信号，不是事实权威。具体事实仍必须回到 repo evidence / Claim Graph。

宿主 AI 硬性规则：
- 不得把页标题、章节顺序、摘要或 importance 当作项目事实证据。
- 解释 Human Manual 骨架时，必须明确说它只是阅读路线/显著性信号。
- 能力、安装、兼容性、运行状态和风险判断必须引用 repo evidence、source path 或 Claim Graph。

- **概览与系统架构**：importance `high`
  - source_paths: README.md, Cargo.toml, rust/core/src/lib.rs, rust/core/src/engine/mod.rs, pyproject.toml
- **核心概念与编程模型**：importance `high`
  - source_paths: python/cocoindex/_internal/app.py, python/cocoindex/_internal/function.py, python/cocoindex/_internal/component_ctx.py, python/cocoindex/_internal/target_state.py, python/cocoindex/_internal/live_component.py
- **连接器、Ops 与集成**：importance `high`
  - source_paths: python/cocoindex/connectors/__init__.py, python/cocoindex/connectors/postgres/__init__.py, python/cocoindex/connectors/lancedb/__init__.py, python/cocoindex/connectors/neo4j/__init__.py, python/cocoindex/connectors/kafka/__init__.py
- **高级主题、运维与扩展**：importance `high`
  - source_paths: python/cocoindex/cli.py, python/cocoindex/_internal/runner.py, python/cocoindex/_internal/environment.py, python/cocoindex/_internal/setting.py, python/cocoindex/_internal/rwlock.py

## Repo Inspection Evidence / 源码检查证据

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `ff6912c3590160a7a2167ce448b5c9c2a8230fbe`
- inspected_files: `README.md`, `pyproject.toml`, `uv.lock`, `docs/package-lock.json`, `docs/package.json`, `docs/src/components/diagrams/README.md`, `docs/src/consts.ts`, `docs/src/content/docs/about/community.mdx`, `docs/src/content/docs/about/telemetry.mdx`, `docs/src/content/docs/advanced_topics/concurrency_control.mdx`, `docs/src/content/docs/advanced_topics/custom_target_connector.mdx`, `docs/src/content/docs/advanced_topics/exception_handlers.mdx`, `docs/src/content/docs/advanced_topics/internal_storage.mdx`, `docs/src/content/docs/advanced_topics/live_component.mdx`, `docs/src/content/docs/advanced_topics/memoization_keys.mdx`, `docs/src/content/docs/advanced_topics/multiple_environments.mdx`, `docs/src/content/docs/advanced_topics/progress_monitoring.mdx`, `docs/src/content/docs/cli.mdx`, `docs/src/content/docs/cli_commands.mdx`, `docs/src/content/docs/common_resources/data_types.mdx`

宿主 AI 硬性规则：
- 没有 repo_clone_verified=true 时，不得声称已经读过源码。
- 没有 repo_inspection_verified=true 时，不得把 README/docs/package 文件判断写成事实。
- 没有 quick_start_verified=true 时，不得声称 Quick Start 已跑通。

## Doramagic Pitfall Constraints / 踩坑约束

这些规则来自 Doramagic 发现、验证或编译过程中的项目专属坑点。宿主 AI 必须把它们当作工作约束，而不是普通说明文字。

### Constraint 1: 失败模式：installation: v1.0.5

- Trigger: Developers should check this installation risk before relying on the project: v1.0.5
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v1.0.5. Context: Observed during installation or first-run setup.
- Why it matters: Upgrade or migration may change expected behavior: v1.0.5
- Evidence: failure_mode_cluster:github_release | https://github.com/cocoindex-io/cocoindex/releases/tag/v1.0.5 | v1.0.5
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 2: 失败模式：configuration: v1.0.7

- Trigger: Developers should check this configuration risk before relying on the project: v1.0.7
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v1.0.7. Context: Observed when using python
- Why it matters: Upgrade or migration may change expected behavior: v1.0.7
- Evidence: failure_mode_cluster:github_release | https://github.com/cocoindex-io/cocoindex/releases/tag/v1.0.7 | v1.0.7
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 3: 能力判断依赖假设

- Trigger: README/documentation is current enough for a first validation pass.
- Host AI rule: 将假设转成下游验证清单。
- Why it matters: 假设不成立时，用户拿不到承诺的能力。
- Evidence: capability.assumptions | https://github.com/cocoindex-io/cocoindex | README/documentation is current enough for a first validation pass.
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 4: 维护活跃度未知

- Trigger: 未记录 last_activity_observed。
- Host AI rule: 补 GitHub 最近 commit、release、issue/PR 响应信号。
- Why it matters: 新项目、停更项目和活跃项目会被混在一起，推荐信任度下降。
- Evidence: evidence.maintainer_signals | https://github.com/cocoindex-io/cocoindex | last_activity_observed missing
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

- Trigger: no_demo
- Evidence: downstream_validation.risk_items | https://github.com/cocoindex-io/cocoindex | no_demo; severity=medium
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 6: 存在评分风险

- Trigger: no_demo
- Why it matters: 风险会影响是否适合普通用户安装。
- Evidence: risks.scoring_risks | https://github.com/cocoindex-io/cocoindex | no_demo; severity=medium
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 7: 失败模式：conceptual: [FEATURE] allow users to specify type hints for component states

- Trigger: Developers should check this conceptual risk before relying on the project: [FEATURE] allow users to specify type hints for component states
- Host AI rule: 复核 source-backed failure mode cluster，并把适用版本和验证路径写入资产。
- Why it matters: Developers may hit a documented source-backed failure mode: [FEATURE] allow users to specify type hints for component states
- Evidence: failure_mode_cluster:github_issue | https://github.com/cocoindex-io/cocoindex/issues/2198 | [FEATURE] allow users to specify type hints for component states
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 8: 失败模式：performance: v1.0.8

- Trigger: Developers should check this performance risk before relying on the project: v1.0.8
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v1.0.8. Context: Observed when using python
- Why it matters: Upgrade or migration may change expected behavior: v1.0.8
- Evidence: failure_mode_cluster:github_release | https://github.com/cocoindex-io/cocoindex/releases/tag/v1.0.8 | v1.0.8
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 9: issue/PR 响应质量未知

- Trigger: issue_or_pr_quality=unknown。
- Host AI rule: 抽样最近 issue/PR，判断是否长期无人处理。
- Why it matters: 用户无法判断遇到问题后是否有人维护。
- Evidence: evidence.maintainer_signals | https://github.com/cocoindex-io/cocoindex | issue_or_pr_quality=unknown
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 10: 发布节奏不明确

- Trigger: release_recency=unknown。
- Host AI rule: 确认最近 release/tag 和 README 安装命令是否一致。
- Why it matters: 安装命令和文档可能落后于代码，用户踩坑概率升高。
- Evidence: evidence.maintainer_signals | https://github.com/cocoindex-io/cocoindex | release_recency=unknown
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。