# helix-db - Doramagic AI Context Pack > 定位：安装前体验与判断资产。它帮助宿主 AI 有一个好的开始，但不代表已经安装、执行或验证目标项目。 ## 充分原则 - **充分原则，不是压缩原则**：AI Context Pack 应该充分到让宿主 AI 在开工前理解项目价值、能力边界、使用入口、风险和证据来源；它可以分层组织，但不以最短摘要为目标。 - **压缩策略**：只压缩噪声和重复内容，不压缩会影响判断和开工质量的上下文。 ## 给宿主 AI 的使用方式 你正在读取 Doramagic 为 helix-db 编译的 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_0002` supported 0.86 ## 它能做什么 - **命令行启动或安装流程**（需要安装后验证）：项目文档中存在可执行命令，真实使用需要在本地或宿主环境中运行这些命令。 证据：`README.md` Claim：`clm_0001` supported 0.86 ## 怎么开始 - `curl -sSL "https://install.helix-db.com" | bash` 证据：`README.md` Claim：`clm_0003` supported 0.86 ## 继续前判断卡 - **当前建议**：仅建议沙盒试装 - **为什么**：项目存在安装命令、宿主配置或本地写入线索，不建议直接进入主力环境，应先在隔离环境试装。 ### 30 秒判断 - **现在怎么做**：仅建议沙盒试装 - **最小安全下一步**：先跑 Prompt Preview；若仍要安装，只在隔离环境试装 - **先别相信**：真实输出质量不能在安装前相信。 - **继续会触碰**：命令执行、本地环境或项目文件、宿主 AI 上下文 ### 现在可以相信 - **适合人群线索：正在使用 Claude/Codex/Cursor/Gemini 等宿主 AI 的开发者**（supported）：有 supported claim 或项目证据支撑，但仍不等于真实安装效果。 证据：`README.md` Claim：`clm_0002` supported 0.86 - **能力存在：命令行启动或安装流程**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`README.md` Claim：`clm_0001` supported 0.86 - **存在 Quick Start / 安装命令线索**（supported）：可以相信项目文档出现过启动或安装入口；不要因此直接在主力环境运行。 证据：`README.md` Claim：`clm_0003` supported 0.86 ### 现在还不能相信 - **真实输出质量不能在安装前相信。**（unverified）：Prompt Preview 只能展示引导方式，不能证明真实项目中的结果质量。 - **宿主 AI 版本兼容性不能在安装前相信。**（unverified）：Claude、Cursor、Codex、Gemini 等宿主加载规则和版本差异必须在真实环境验证。 - **不会污染现有宿主 AI 行为，不能直接相信。**（inferred）：Skill、plugin、AGENTS/CLAUDE/GEMINI 指令可能改变宿主 AI 的默认行为。 - **可安全回滚不能默认相信。**（unverified）：除非项目明确提供卸载和恢复说明，否则必须先在隔离环境验证。 - **真实安装后是否与用户当前宿主 AI 版本兼容？**（unverified）：兼容性只能通过实际宿主环境验证。 - **项目输出质量是否满足用户具体任务？**（unverified）：安装前预览只能展示流程和边界，不能替代真实评测。 - **安装命令是否需要网络、权限或全局写入？**（unverified）：这影响企业环境和个人环境的安装风险。 证据：`README.md` ### 继续会触碰什么 - **命令执行**：包管理器、网络下载、本地插件目录、项目配置或用户主目录。 原因：运行第一条命令就可能产生环境改动；必须先判断是否值得跑。 证据：`README.md` - **本地环境或项目文件**：安装结果、插件缓存、项目配置或本地依赖目录。 原因：安装前无法证明写入范围和回滚方式，需要隔离验证。 证据：`README.md` - **宿主 AI 上下文**：AI Context Pack、Prompt Preview、Skill 路由、风险规则和项目事实。 原因：导入上下文会影响宿主 AI 后续判断，必须避免把未验证项包装成事实。 ### 最小安全下一步 - **先跑 Prompt Preview**：用安装前交互式试用判断工作方式是否匹配，不需要授权或改环境。（适用：任何项目都适用，尤其是输出质量未知时。） - **只在隔离目录或测试账号试装**：避免安装命令污染主力宿主 AI、真实项目或用户主目录。（适用：存在命令执行、插件配置或本地写入线索时。） - **安装后只验证一个最小任务**：先验证加载、兼容、输出质量和回滚，再决定是否深用。（适用：准备从试用进入真实工作流时。） ### 退出方式 - **保留安装前状态**：记录原始宿主配置和项目状态，后续才能判断是否可恢复。 - **记录安装命令和写入路径**：没有明确卸载说明时，至少要知道哪些目录或配置需要手动清理。 - **如果没有回滚路径，不进入主力环境**：不可回滚是继续前阻断项，不应靠信任或运气继续。 ## 哪些只能预览 - 解释项目适合谁和能做什么 - 基于项目文档演示典型对话流程 - 帮助用户判断是否值得安装或继续研究 ## 哪些必须安装后验证 - 真实安装 Skill、插件或 CLI - 执行脚本、修改本地文件或访问外部服务 - 验证真实输出质量、性能和兼容性 ## 边界与风险判断卡 - **把安装前预览误认为真实运行**：用户可能高估项目已经完成的配置、权限和兼容性验证。 处理方式：明确区分 prompt_preview_can_do 与 runtime_required。 Claim：`clm_0004` inferred 0.45 - **命令执行会修改本地环境**：安装命令可能写入用户主目录、宿主插件目录或项目配置。 处理方式：先在隔离环境或测试账号中运行。 证据：`README.md` Claim：`clm_0005` 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。 ### 任务路由 - **命令行启动或安装流程**：先说明这是安装后验证能力，再给出安装前检查清单。 边界：必须真实安装或运行后验证。 证据：`README.md` Claim：`clm_0001` supported 0.86 ### 上下文规模 - 文件总数：86 - 重要文件覆盖：40/86 - 证据索引条目：42 - 角色 / Skill 条目：9 ### 证据不足时的处理 - **missing_evidence**：说明证据不足，要求用户提供目标文件、README 段落或安装后验证记录；不要补全事实。 - **out_of_scope_request**：说明该任务超出当前 AI Context Pack 证据范围，并建议用户先查看 Human Manual 或真实安装后验证。 - **runtime_request**：给出安装前检查清单和命令来源，但不要替用户执行命令或声称已执行。 - **source_conflict**：同时展示冲突来源，标记为待核实，不要强行选择一个版本。 ## Prompt Recipes ### 适配判断 - 目标：判断这个项目是否适合用户当前任务。 - 预期输出：适配结论、关键理由、证据引用、安装前可预览内容、必须安装后验证内容、下一步建议。 ```text 请基于 helix-db 的 AI Context Pack，先问我 3 个必要问题，然后判断它是否适合我的任务。回答必须包含：适合谁、能做什么、不能做什么、是否值得安装、证据来自哪里。所有项目事实必须引用 evidence_refs、source_paths 或 claim_id。 ``` ### 安装前体验 - 目标：让用户在安装前感受核心工作流，同时避免把预览包装成真实能力或营销承诺。 - 预期输出：一段带边界标签的体验剧本、安装后验证清单和谨慎建议；不含真实运行承诺或强营销表述。 ```text 请把 helix-db 当作安装前体验资产，而不是已安装工具或真实运行环境。 请严格输出四段： 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 请基于 helix-db 的 AI Context Pack，生成一段我可以粘贴给宿主 AI 的开工前指令。这段指令必须遵守 not_runtime=true，不能声称项目已经安装、运行或产生真实结果。 ``` ## 角色 / Skill 索引 - 共索引 9 个角色 / Skill / 项目文档条目。 - **Getting Started**（project_doc）：HelixDB : a graph-vector database for knowledge graphs and AI memory. Built from scratch in Rust. website docs discord X/twitter 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`README.md` - **Helix CLI**（project_doc）：Command-line interface for managing v2 Helix projects, local development instances, and Enterprise Cloud deployments. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`helix-cli/README.md` - **HelixDB Go SDK**（project_doc）：Dynamic-first Go SDK for building and executing HelixDB queries. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`sdks/go/README.md` - **helix-db**（project_doc）：There is good documentation in the crate doc comments, especially in src/lib.rs . AI agents should read the source code and doc comments to get a feel for the query-building patterns and the full API surface. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`sdks/rust/README.md` - **helix-dsl-macros**（project_doc）：Procedural macros for the helix-dsl ../README.md query registration system. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`sdks/rust/helix-dsl-macros/README.md` - **@helix-db/helix-db**（project_doc）：TypeScript query DSL and HTTP client for HelixDB. This package builds the same JSON AST shape as the Rust helix-db SDK crate, and ships a network Client that mirrors the Rust client. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`sdks/typescript/README.md` - **Rust/TypeScript DSL Parity**（project_doc）：This suite proves that the Rust DSL and TypeScript DSL emit the same dynamic query JSON, then executes the runtime-safe fixtures against separate fresh local Helix instances. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`sdks/tests/parity/README.md` - **HelixDB Community Conduct Guidelines**（project_doc）：HelixDB Community Conduct Guidelines 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`CODE_OF_CONDUCT.md` - **Contributing to HelixDB**（project_doc）：Overview HelixDB is a high-performance graph-vector database built in Rust, optimized for RAG and AI applications. It combines graph traversals, vector similarity search, and full-text search in a single database. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`CONTRIBUTORS.md` ## 证据索引 - 共索引 42 条证据。 - **Getting Started**（documentation）：HelixDB : a graph-vector database for knowledge graphs and AI memory. Built from scratch in Rust. website docs discord X/twitter 证据：`README.md` - **Helix CLI**（documentation）：Command-line interface for managing v2 Helix projects, local development instances, and Enterprise Cloud deployments. 证据：`helix-cli/README.md` - **HelixDB Go SDK**（documentation）：Dynamic-first Go SDK for building and executing HelixDB queries. 证据：`sdks/go/README.md` - **helix-db**（documentation）：There is good documentation in the crate doc comments, especially in src/lib.rs . AI agents should read the source code and doc comments to get a feel for the query-building patterns and the full API surface. 证据：`sdks/rust/README.md` - **helix-dsl-macros**（documentation）：Procedural macros for the helix-dsl ../README.md query registration system. 证据：`sdks/rust/helix-dsl-macros/README.md` - **@helix-db/helix-db**（documentation）：TypeScript query DSL and HTTP client for HelixDB. This package builds the same JSON AST shape as the Rust helix-db SDK crate, and ships a network Client that mirrors the Rust client. 证据：`sdks/typescript/README.md` - **Package**（package_manifest）：{ "name": "@helix-db/helix-db", "version": "2.0.3", "description": "TypeScript library for working with HelixDB", "type": "module", "main": "dist/index.js", "types": "dist/index.d.ts", "exports": { ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js", "default": "./dist/index.js" } }, "files": "dist" , "author": "HelixDB", "license": "Apache-2.0", "homepage": "https://github.com/HelixDB/helix-db/tree/main/sdks/typescript", "repository": { "type": "git", "url": "git+https://github.com/HelixDB/helix-db.git", "directory": "sdks/typescript" }, "bugs": { "url": "https://github.com/helixdb/helix-db/issues" }, "keywords": "helix", "helixdb", "graph-database", "vector-database", "query-… 证据：`sdks/typescript/package.json` - **Rust/TypeScript DSL Parity**（documentation）：This suite proves that the Rust DSL and TypeScript DSL emit the same dynamic query JSON, then executes the runtime-safe fixtures against separate fresh local Helix instances. 证据：`sdks/tests/parity/README.md` - **License**（source_file）：Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ 证据：`LICENSE` - **License**（source_file）：Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ 证据：`sdks/typescript/LICENSE` - **Chef**（source_file）：use crate::InitTarget; ⋮---- use crate::config::DEFAULT LOCAL PORT; use crate::enterprise cloud::cloud base url; use crate::metrics sender::MetricsSender; ⋮---- use crate::prompts; ⋮---- use flate2::Compression; use flate2::write::GzEncoder; use helix metrics::events::ChefEvent; ⋮---- use std::env; use std::fs; use std::io::Write; ⋮---- /// The Helix brand + styling guide. Written verbatim to DESIGN.md in every chef /// project and referenced from AGENT PROMPT TEMPLATE + . ⋮---- /// project and referenced from AGENT PROMPT TEMPLATE + . /// It is fully self-contained — the generated project has no access to the ⋮---- /// It is fully self-contained — the generated project has no access to the… 证据：`helix-cli/src/commands/chef.rs` - **Config**（source_file）：use crate::commands::auth::require auth; use crate::config::WorkspaceConfig; ⋮---- use crate::project::ProjectContext; use crate::prompts; ⋮---- use color eyre::owo colors::OwoColorize; ⋮---- use serde::Serialize; pub async fn run action: Option - Result { ⋮---- Some ConfigAction::Workspace { action } = run workspace Some action .await, Some ConfigAction::Project { action } = run project Some action .await, Some ConfigAction::Cluster { action } = run cluster Some action .await, None if prompts::is interactive = interactive config .await, None = Err eyre! ⋮---- pub async fn run workspace action: Option - Result { ⋮---- Some WorkspaceConfigAction::List { format } = workspace list format .awai… 证据：`helix-cli/src/commands/config.rs` - **Enterprise Deploy**（source_file）：use crate::commands::auth::require auth; ⋮---- use crate::enterprise cloud::cloud base url; use crate::output; use crate::project::ProjectContext; ⋮---- use serde json::json; use std::collections::HashMap; ⋮---- use std::process::Command; ⋮---- pub crate async fn deploy enterprise by cluster id ⋮---- .iter .find , config config.cluster id == cluster id ⋮---- return Err eyre! ⋮---- deploy enterprise project, instance name, config .await ⋮---- pub crate async fn deploy enterprise ⋮---- let credentials = require auth .await?; let queries project dir = enterprise queries dir project ; let query json path = compile enterprise queries &queries project dir ?; let query json bytes = std::fs::read &… 证据：`helix-cli/src/commands/enterprise_deploy.rs` - **Mod**（source_file）：use crate::commands::auth::require auth; use crate::config::InstanceInfo; use crate::enterprise cloud::cloud base url; use crate::local runtime::LocalRuntime; use crate::project::ProjectContext; use crate::prompts; ⋮---- use serde::Deserialize; ⋮---- struct LogsRangeResponse { ⋮---- struct LogEntry { ⋮---- pub async fn run ⋮---- let instance = resolve instance &project, instance ?; match project.config.get instance &instance ? { ⋮---- if range start.is some end.is some { return Err eyre! ⋮---- LocalRuntime::new &project .logs &instance, follow ?; ⋮---- let credentials = require auth .await?; let start, end = parse range range, start, end ?; ⋮---- query enterprise logs &config.cluster id, &c… 证据：`helix-cli/src/commands/logs/mod.rs` - **Mod**（source_file）：pub mod add; pub mod auth; pub mod chef; pub mod config; pub mod delete; pub mod enterprise deploy; pub mod feedback; pub mod init; pub mod logs; pub mod metrics; pub mod prune; pub mod push; pub mod query; pub mod restart; pub mod skills; pub mod start; pub mod status; pub mod stop; pub mod sync; pub mod update; 证据：`helix-cli/src/commands/mod.rs` - **Query**（source_file）：use crate::config::InstanceInfo; use crate::errors::CliError; use crate::project::ProjectContext; ⋮---- use serde json::Value; ⋮---- pub async fn run ⋮---- let = dotenvy::from path project.root.join ".env" ; let instance = instance.unwrap or else "dev".to string ; let request json = parse query request file, json, ts, ts file ?; validate dynamic request &request json, warm ?; ⋮---- let mut request = match project.config.get instance &instance ? { ⋮---- let host = host.unwrap or else "localhost".to string ; let port = port.unwrap or config.port ; client.post format! "http://{host}:{port}/v1/query" ⋮---- let gateway url = config.gateway url.as deref .ok or else { eyre! ⋮---- let auth value =… 证据：`helix-cli/src/commands/query.rs` - **Sync**（source_file）：use crate::commands::auth::require auth; ⋮---- use crate::project::ProjectContext; use crate::prompts; use color eyre::owo colors::OwoColorize; ⋮---- use serde::Deserialize; ⋮---- use std::fs; ⋮---- struct SyncFileMetadata { ⋮---- struct EnterpriseSyncResponse { ⋮---- struct ManifestEntry { ⋮---- struct ManifestDiff { ⋮---- impl ManifestDiff { fn all files &self - Vec { ⋮---- files.extend self.local only.iter .cloned ; files.extend self.remote only.iter .cloned ; files.extend self.changed.iter .cloned ; files.sort ; files.dedup ; ⋮---- fn is empty &self - bool { self.local only.is empty && self.remote only.is empty && self.changed.is empty ⋮---- enum DivergenceAuthority { ⋮---- enum Snapsho… 证据：`helix-cli/src/commands/sync.rs` - **Config**（source_file）：use crate::errors::ConfigError; ⋮---- use std::collections::HashMap; use std::fs; ⋮---- pub struct WorkspaceConfig { ⋮---- impl WorkspaceConfig { pub fn config path - Result { let home = dirs::home dir .ok or ConfigError::HomeDirNotFound ?; Ok home.join ".helix" .join "config" ⋮---- pub fn load - Result { ⋮---- if !path.exists { return Ok Self::default ; ⋮---- fs::read to string &path .map err source ConfigError::ReadWorkspaceConfig { path: path.clone , ⋮---- .map err source ConfigError::ParseWorkspaceConfig { path, source } ⋮---- pub fn save &self - Result { ⋮---- if let Some parent = path.parent { fs::create dir all parent .map err source ConfigError::CreateWorkspaceDir { path: parent.to… 证据：`helix-cli/src/config.rs` - **Errors**（source_file）：use color eyre::owo colors::OwoColorize; use std::fmt; use std::path::PathBuf; use thiserror::Error; ⋮---- pub enum CliErrorSeverity { ⋮---- impl CliErrorSeverity { pub fn label &self - &'static str { ⋮---- pub fn color code &self, text: T - String { ⋮---- CliErrorSeverity::Error = text.as ref .red .bold .to string , CliErrorSeverity::Warning = text.as ref .yellow .bold .to string , CliErrorSeverity::Info = text.as ref .blue .bold .to string , ⋮---- pub struct CliError { ⋮---- impl CliError { pub fn new message: S - Self { ⋮---- message: message.into , ⋮---- pub fn warning message: S - Self { ⋮---- pub fn info message: S - Self { ⋮---- pub fn with context mut self, context: S - Self { self.… 证据：`helix-cli/src/errors.rs` - **Lib**（source_file）：pub mod commands; pub mod config; pub mod enterprise cloud; pub mod errors; pub mod local runtime; pub mod metrics sender; pub mod output; pub mod port; pub mod project; pub mod prompts; pub mod setup; pub mod sse client; pub mod ts query; pub mod update; pub mod utils; ⋮---- pub enum AuthAction { ⋮---- pub enum InitTarget { ⋮---- impl InitTarget { pub fn skills override &self - Option { ⋮---- Some true ⋮---- Some false ⋮---- pub enum AddTarget { ⋮---- pub enum SkillsAction { ⋮---- pub enum MetricsAction { ⋮---- pub enum ConfigOutputFormat { ⋮---- pub enum ConfigAction { ⋮---- pub enum WorkspaceConfigAction { ⋮---- pub enum ProjectConfigAction { ⋮---- pub enum ClusterConfigAction { 证据：`helix-cli/src/lib.rs` - **arg short = 'h', long = "help", action = clap::ArgAction::HelpShort**（source_file）：use color eyre::owo colors::OwoColorize; use eyre::Result; ⋮---- use std::io::IsTerminal; ⋮---- const HELIX ORANGE: Color = Color::Rgb RgbColor 255, 165, 54 ; ⋮---- .header Style::new .bold .fg color Some HELIX ORANGE .usage Style::new .bold .fg color Some HELIX ORANGE .literal ⋮---- .bold .fg color Some Color::Ansi AnsiColor::Cyan , ⋮---- .placeholder Style::new .fg color Some Color::Ansi AnsiColor::Green .error ⋮---- .fg color Some Color::Ansi AnsiColor::Red , ⋮---- .valid Style::new .fg color Some Color::Ansi AnsiColor::Green .invalid ⋮---- .fg color Some Color::Ansi AnsiColor::Yellow , ⋮---- struct Cli { ⋮---- enum Commands { ⋮---- /// Print help arg short = 'h', long = "help", action =… 证据：`helix-cli/src/main.rs` - **Output**（source_file）：use color eyre::owo colors::OwoColorize; ⋮---- use std::io::IsTerminal; ⋮---- pub crate fn standard spinner style - ProgressStyle { ⋮---- .tick strings &STANDARD SPINNER TICKS .template " {spinner:.blue} {msg}" .expect "valid template" ⋮---- pub enum Verbosity { ⋮---- impl Verbosity { pub fn current - Self { match VERBOSITY.load Ordering::Relaxed { ⋮---- pub fn set level: Verbosity { VERBOSITY.store level as u8, Ordering::Relaxed ; ⋮---- pub fn from flags quiet: bool, verbose: bool - Self { ⋮---- pub fn show quiet &self - bool { ⋮---- pub fn show normal &self - bool { ⋮---- pub fn show verbose &self - bool { ⋮---- impl PartialOrd for Verbosity { fn partial cmp &self, other: &Self - Option {… 证据：`helix-cli/src/output.rs` - **Sse Client**（source_file）：use futures util::StreamExt; use indicatif::ProgressBar; ⋮---- use std::io::IsTerminal; use std::time::Duration; ⋮---- pub enum SseEvent { ⋮---- pub struct SseClient { ⋮---- impl SseClient { pub fn new url: String - Self { ⋮---- pub fn header mut self, key: impl Into , value: impl Into - Self { self.headers.push key.into , value.into ; ⋮---- pub fn timeout mut self, timeout: Duration - Self { ⋮---- pub fn post mut self - Self { ⋮---- pub async fn connect &self, mut handler: F - Result ⋮---- let client = reqwest::Client::builder .timeout self.timeout .build ?; ⋮---- client.post &self.url ⋮---- client.get &self.url ⋮---- request = request.header key, value ; ⋮---- let mut event source = reque… 证据：`helix-cli/src/sse_client.rs` - **Ts Query**（source_file）：use crate::errors::CliError; use crate::output::Step; use crate::project::get helix cache dir; use crate::utils::command exists; ⋮---- use serde json::Value; use std::fs; ⋮---- use std::process::Command; ⋮---- pub fn build request from ts snippet: &str - Result { let snippet = snippet.trim ; if snippet.is empty { return Err CliError::new "the TypeScript query is empty" .with hint "pass an expression, e.g. -e 'readBatch .varAs \"c\", g .nWithLabel \"User\" .count .returning \"c\" '" .into ; ⋮---- ensure node ?; let runtime dir = ensure sdk ?; let wrapper path = write wrapper &runtime dir, snippet ?; let json = match run node &runtime dir, &wrapper path { ⋮---- return Err err ; ⋮---- serde js… 证据：`helix-cli/src/ts_query.rs` - **Lib**（source_file）：pub mod events; ⋮---- use serde::Serialize; use tokio::task::JoinHandle; ⋮---- let home dir = std::env::var "HOME" .unwrap or "~/".to string ; let config path = &format! "{home dir}/.helix/credentials" ; ⋮---- fs::read to string config path .unwrap or default ⋮---- // read from credentials file for line in CONFIG.lines { if let Some key, value = line.split once "=" && key.to lowercase == "helix user id" ⋮---- String::new .leak ⋮---- && key.to lowercase .as str == "metrics" ⋮---- return value.to string .parse .unwrap or true ; ⋮---- // Thread-local buffer for events thread local! { ⋮---- // Global state for metrics system struct MetricsState { ⋮---- // Read threshold from environment or use… 证据：`metrics/src/lib.rs` - **Main**（source_file）：fn query1 params: String - helix db::ReadBatch { read batch .var as ⋮---- g .n where SourcePredicate::eq "username", params , ⋮---- g .n NodeRef::var "user" .out Some "FOLLOWS" .dedup .limit 100 , ⋮---- .returning "user", "friends" ⋮---- fn main { let = helix db::generate .expect "should work" ; let query = query1 "alice".to string ; 证据：`sdks/rust/example/src/main.rs` - **Lib**（source_file）：use proc macro::TokenStream; ⋮---- enum QueryKind { ⋮---- enum ParamTypeSpec { ⋮---- impl ParamTypeSpec { fn to tokens &self - proc macro2::TokenStream { ⋮---- Self::Bool = quote! { ::helix db::QueryParamType::Bool }, Self::I64 = quote! { ::helix db::QueryParamType::I64 }, Self::F64 = quote! { ::helix db::QueryParamType::F64 }, Self::F32 = quote! { ::helix db::QueryParamType::F32 }, Self::String = quote! { ::helix db::QueryParamType::String }, Self::DateTime = quote! { ::helix db::QueryParamType::DateTime }, Self::Bytes = quote! { ::helix db::QueryParamType::Bytes }, Self::Value = quote! { ::helix db::QueryParamType::Value }, Self::Object = quote! { ::helix db::QueryParamType::Object }, ⋮--… 证据：`sdks/rust/helix-dsl-macros/src/lib.rs` - **Dsl**（source_file）：use std::marker::PhantomData; ⋮---- pub use helix dsl macros::register; ⋮---- pub mod private { use std::collections::BTreeMap; pub use inventory; pub fn dynamic query value from property value ⋮---- fn convert ⋮---- Ok match value { ⋮---- .to rfc3339 .ok or else crate::DynamicQueryError::invalid datetime path, value ?, ⋮---- return Err crate::DynamicQueryError::unsupported bytes path ; ⋮---- .into iter .map crate::DynamicQueryValue::I64 .collect , ⋮---- .map crate::DynamicQueryValue::F64 ⋮---- .map crate::DynamicQueryValue::F32 ⋮---- .map crate::DynamicQueryValue::String ⋮---- .enumerate .map index, value convert value, format! "{} {} ", path, index ⋮---- .map key, value { let entry path =… 证据：`sdks/rust/src/dsl.rs` - **derive Default**（source_file）：pub mod dsl; pub mod query generator; use std::marker::PhantomData; ⋮---- pub use dsl::prelude; ⋮---- use thiserror::Error; ⋮---- pub struct Client { ⋮---- pub type HelixDBClient = Client; ⋮---- pub enum HelixError { ⋮---- impl Client { pub fn new url: Option - Result { let url = reqwest::Url::parse url.unwrap or "http://localhost:6969" .map err e HelixError::InvalidURL e.to string ? .join "/v1/query" .map err e HelixError::InvalidURL e.to string ?; Ok Self { ⋮---- pub fn with api key mut self, api key: Option - Self { self.api key = api key.map key key.to string ; ⋮---- pub fn query Deserialize &self - QueryBuilder { ⋮---- pub struct QueryBuilder { ⋮---- /// Which Helix query route a Query… 证据：`sdks/rust/src/lib.rs` - **HelixDB Community Conduct Guidelines**（documentation）：HelixDB Community Conduct Guidelines 证据：`CODE_OF_CONDUCT.md` - **Contributing to HelixDB**（documentation）：Overview HelixDB is a high-performance graph-vector database built in Rust, optimized for RAG and AI applications. It combines graph traversals, vector similarity search, and full-text search in a single database. 证据：`CONTRIBUTORS.md` - **.Prettierrc**（structured_config）：{ "printWidth": 140, "trailingComma": "all" } 证据：`sdks/typescript/.prettierrc.json` - **Tsconfig.Build**（structured_config）：{ "extends": "./tsconfig.json", "compilerOptions": { "rootDir": "src", "outDir": "dist", "sourceMap": true, "declaration": true }, "include": "src/ / .ts" , "exclude": "test/ ", "scripts/ " } 证据：`sdks/typescript/tsconfig.build.json` - **Tsconfig**（structured_config）：{ "compilerOptions": { "target": "ES2022", "module": "NodeNext", "moduleResolution": "NodeNext", "strict": true, "declaration": true, "sourceMap": true, "outDir": "dist-dev", "rootDir": ".", "skipLibCheck": true, "forceConsistentCasingInFileNames": true }, "include": "src/ / .ts", "test/ / .ts", "scripts/ / .ts" } 证据：`sdks/typescript/tsconfig.json` - **.gitignore**（source_file）：.helix/ .log test/ /thoughts/ .claude/ hack/ .DS Store /tmp /data claude.md .cargo/ /dist /node modules 证据：`.gitignore` - **Cargo**（source_file）：workspace members = "helix-cli", "metrics", "sdks/rust", resolver = "2" 证据：`Cargo.toml` - **Clippy Check**（source_file）：set -eu cargo clippy --workspace -- -D warnings 证据：`clippy_check.sh` - **helix-cli/.gitignore**（source_file）：.helix/ target/ .log 证据：`helix-cli/.gitignore` - **Cargo**（source_file）：package name = "helix-cli" version = "3.0.5" edition = "2024" 证据：`helix-cli/Cargo.toml` - **Build**（source_file）：export PATH="$HOME/.cargo/bin:$PATH" if "$1" = "dev" ; then cargo install --debug --force --path . --root ~/.local else cargo install --force --path . --root ~/.local fi if ! echo "$PATH" grep -q "$HOME/.local/bin"; then if ! grep -Fxq 'export PATH="$HOME/.local/bin:$PATH"' ~/.bashrc; then echo 'export PATH="$HOME/.local/bin:$PATH"' ~/.bashrc fi if ! grep -Fxq 'export PATH="$HOME/.local/bin:$PATH"' ~/.zshrc; then echo 'export PATH="$HOME/.local/bin:$PATH"' ~/.zshrc fi export PATH="$HOME/.local/bin:$PATH" fi 证据：`helix-cli/build.sh` - **Logging functions**（source_file）：set -euo pipefail readonly REPO="HelixDB/helix-db" readonly BINARY NAME="helix" readonly DEFAULT INSTALL DIR="$HOME/.local/bin" readonly RED='\033 0;31m' readonly GREEN='\033 0;32m' readonly YELLOW='\033 1;33m' readonly BLUE='\033 0;34m' readonly NC='\033 0m' INSTALL DIR="" FORCE INSTALL=false SYSTEM INSTALL=false Logging functions log error { echo -e "${RED}ERROR:${NC} $ " &2; } log success { echo -e "${GREEN}SUCCESS:${NC} $ "; } log info { echo -e "${BLUE}INFO:${NC} $ "; } log warn { echo -e "${YELLOW}WARN:${NC} $ "; } Print usage information usage { cat Install directory default: ~/.local/bin -s, --system System install /usr/local/bin, requires sudo -f, --force Force install even if same… 证据：`helix-cli/install.sh` - **Cargo**（source_file）：package name = "helix-metrics" version = "0.1.1" edition = "2024" authors = "HelixDB Team" repository = "https://github.com/HelixDB/helix-db" license = "AGPL-3.0" description = "Metrics for HelixDB" 证据：`metrics/Cargo.toml` ## 宿主 AI 必须遵守的规则 - **把本资产当作开工前上下文，而不是运行环境。**：AI Context Pack 只包含证据化项目理解，不包含目标项目的可执行状态。 证据：`README.md`, `helix-cli/README.md`, `sdks/go/README.md` - **回答用户时区分可预览内容与必须安装后才能验证的内容。**：安装前体验的消费者价值来自降低误装和误判，而不是伪装成真实运行。 证据：`README.md`, `helix-cli/README.md`, `sdks/go/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, helix-cli/README.md, helix-cli/src/main.rs - **CLI 命令与本地运行时管理**：importance `high` - source_paths: helix-cli/src/main.rs, helix-cli/src/local_runtime.rs, helix-cli/src/commands/start.rs, helix-cli/src/commands/stop.rs, helix-cli/src/commands/query.rs - **Rust / TypeScript / Go SDK 与查询 DSL**：importance `high` - source_paths: sdks/rust/src/lib.rs, sdks/rust/src/dsl.rs, sdks/rust/src/query_generator.rs, sdks/rust/README.md, sdks/rust/helix-dsl-macros/src/lib.rs - **高级检索特性、云部署与社区路线**：importance `high` - source_paths: README.md, helix-cli/src/commands/sync.rs, helix-cli/src/enterprise_cloud.rs, helix-cli/src/commands/enterprise_deploy.rs, helix-cli/src/commands/push.rs ## Repo Inspection Evidence / 源码检查证据 - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `3a753be6be4b7345abb2f63d1e826875ceacd5cc` - inspected_files: `README.md` 宿主 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: 来源证据：[Feature]: Fuzzy Keyword Search (RapidFuzz) to Enhance BM25 in HelixDB - Trigger: GitHub 社区证据显示该项目存在一个安全/权限相关的待验证问题：[Feature]: Fuzzy Keyword Search (RapidFuzz) to Enhance BM25 in HelixDB - Host AI rule: 来源问题仍为 open，Pack Agent 需要复核是否仍影响当前版本。 - Why it matters: 可能影响授权、密钥配置或安全边界。 - Evidence: community_evidence:github | cevd_0c11aafbc9004130b73b57570687726c | https://github.com/HelixDB/helix-db/issues/781 | 来源类型 github_issue 暴露的待验证使用条件。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 2: 来源证据：[Feature]: Add helix branch command to clone database for new instances - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：[Feature]: Add helix branch command to clone database for new instances - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | cevd_d0ffd160ec924afe9da517ca2c70cf1f | https://github.com/HelixDB/helix-db/issues/787 | 来源讨论提到 docker 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 3: 来源证据：feat: Hybrid Search with RRF (SearchBM25 + SearchV) - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：feat: Hybrid Search with RRF (SearchBM25 + SearchV) - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | cevd_3740a047826c44fbb0618fb414c2b2bb | https://github.com/HelixDB/helix-db/issues/828 | 来源类型 github_issue 暴露的待验证使用条件。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 4: 可能修改宿主 AI 配置 - Trigger: 项目面向 Claude/Cursor/Codex/Gemini/OpenCode 等宿主，或安装命令涉及用户配置目录。 - Host AI rule: 列出会写入的配置文件、目录和卸载/回滚步骤。 - Why it matters: 安装可能改变本机 AI 工具行为，用户需要知道写入位置和回滚方法。 - Evidence: capability.host_targets | hn_item:48478148 | https://news.ycombinator.com/item?id=48478148 | host_targets=mcp_host, claude_code, claude - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 5: 来源证据：[Feature]: Bulk import endpoint for batch node/edge creation - Trigger: GitHub 社区证据显示该项目存在一个配置相关的待验证问题：[Feature]: Bulk import endpoint for batch node/edge creation - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能影响升级、迁移或版本选择。 - Evidence: community_evidence:github | cevd_5246413a7d6d4e6387802d5337c37a63 | https://github.com/HelixDB/helix-db/issues/896 | 来源讨论提到 node 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 6: 来源证据：[Feature]: Combining results from multiple SearchV calls into a single RRF-ranked list - Trigger: GitHub 社区证据显示该项目存在一个能力理解相关的待验证问题：[Feature]: Combining results from multiple SearchV calls into a single RRF-ranked list - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | cevd_459459393fb747beb350857e7c23bae6 | https://github.com/HelixDB/helix-db/issues/863 | 来源类型 github_issue 暴露的待验证使用条件。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 7: 能力判断依赖假设 - Trigger: README/documentation is current enough for a first validation pass. - Host AI rule: 将假设转成下游验证清单。 - Why it matters: 假设不成立时，用户拿不到承诺的能力。 - Evidence: capability.assumptions | hn_item:48478148 | https://news.ycombinator.com/item?id=48478148 | README/documentation is current enough for a first validation pass. - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 8: 维护活跃度未知 - Trigger: 未记录 last_activity_observed。 - Host AI rule: 补 GitHub 最近 commit、release、issue/PR 响应信号。 - Why it matters: 新项目、停更项目和活跃项目会被混在一起，推荐信任度下降。 - Evidence: evidence.maintainer_signals | hn_item:48478148 | https://news.ycombinator.com/item?id=48478148 | last_activity_observed missing - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 9: 下游验证发现风险项 - Trigger: no_demo - Host AI rule: 进入安全/权限治理复核队列。 - Why it matters: 下游已经要求复核，不能在页面中弱化。 - Evidence: downstream_validation.risk_items | hn_item:48478148 | https://news.ycombinator.com/item?id=48478148 | no_demo; severity=medium - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 10: 存在评分风险 - Trigger: no_demo - Host AI rule: 把风险写入边界卡，并确认是否需要人工复核。 - Why it matters: 风险会影响是否适合普通用户安装。 - Evidence: risks.scoring_risks | hn_item:48478148 | https://news.ycombinator.com/item?id=48478148 | no_demo; severity=medium - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。