@agentcairn/core

中文文档
0.3.0发布于 2026/10/22MITTypeScriptES Module构建来源已验证近 30 天下载 1805

Neo4j-backed memory layer for Agent Cairn: memories, briefings, project identity and accounts.

原始使用文档

@agentcairn/core

The database layer of Agent Cairn: shared project memory for AI coding agents, stored in Neo4j.

This package has no server and no UI. It provides:

  • Schema and migrations (ensureSchema): constraints, indexes, and in-place conversion of older data shapes. Plain Cypher; works on Neo4j Community.
  • Memories: remember (with atomic supersedes), recall (fulltext, scoped to a project), getMemory, forgetMemory, listAreas.
  • Briefings: buildBriefing / assembleBriefing produce a token-budgeted summary of a project.
  • Staleness: checkStaleness compares a memory's recorded commit and paths with a working tree.
  • Project identity: git-remote normalization and hashing, .cairn.json links, resolveProject, registerProject.
  • Accounts and tokens: first-admin creation, password verification (scrypt), hashed API tokens.
  • Explore queries for the dashboard, and a read-only Cypher runner.
import { openBrain, loadConfig, ensureSchema, ensureProject, remember, buildBriefing } from '@agentcairn/core'

const brain = openBrain(loadConfig()) // NEO4J_URI, NEO4J_USER, NEO4J_PASSWORD
await ensureSchema(brain)
await ensureProject(brain, 'my-project')
await remember(brain, 'my-project', { kind: 'gotcha', title: 'Cache keys include the version', body: 'Bumping it invalidates everything.', area: 'platform' })
console.log((await buildBriefing(brain, 'my-project')).text)
await brain.close()

See the architecture notes for the data model. MIT licensed.

版本与发布记录

@agentcairn/core 共发布 13 个版本,首次发布于 2026/10/18;过去 12 个月发布了 13 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.0latest2026/10/2216 天前
0.2.42026/10/2118 天前
0.2.32026/10/2118 天前
0.2.22026/10/2118 天前
0.2.12026/10/2118 天前
0.2.02026/10/2019 天前

关于 @agentcairn/core 的常见问题

@agentcairn/core 是什么?

Neo4j-backed memory layer for Agent Cairn: memories, briefings, project identity and accounts.

如何安装 @agentcairn/core?

在项目目录运行 npm install @agentcairn/core,或使用 pnpm add / yarn add / bun add。

@agentcairn/core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@agentcairn/core 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@agentcairn/core 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.12。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@agentcairn/core 可以商用吗?

@agentcairn/core 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@agentcairn/core 的下载量有多少?

根据 npm 官方下载统计,@agentcairn/core 在 2026/10/05 – 2026/11/03 这 30 天内被下载 1,805 次,日均约 60 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@agentcairn/core 还在维护吗?

最新版本 0.3.0 发布于 2026/10/22(16 天前);至今共发布 13 个版本,其中过去 12 个月发布了 13 个;首次发布于 2026/10/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。