@geohar/pi-cribsheet

中文文档
0.25.0发布于 2026/11/17MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 5479

Pi extension: run the crib (cribsheet) memory + code-index MCP server via sharedserver, inject the reach-for-crib directive, and ship the /crib recall command. Pairs with pi-mcp-adapter.

原始使用文档
文档目录6 节
  1. How it fits together
  2. Stand-down when combiner-served
  3. Install
  4. Configuration
  5. Development
  6. License

@geohar/pi-cribsheet

A Pi extension that makes cribsheet (the crib memory + code-index MCP server) available to Pi: it starts crib (supervised by sharedserver), injects the reach-for-crib directive into the system prompt, and ships the /crib recall command.

It is the Pi counterpart of cribsheet's Claude Code and OpenCode plugins, and shares the same crib server and sharedserver instance — so Pi, Claude Code, OpenCode, and Neovim all talk to one refcounted process.

How it fits together

Pi has no MCP of its own. Two pieces give it crib:

  1. pi-mcp-adapter — the Pi package that speaks MCP. It reads its own mcp.json and connects to crib over HTTP. Install it too (pi install npm:pi-mcp-adapter).
  2. This extension — the process + directive + command half:
    • Run crib on session_start via sharedserver use … -- crib --mcp --http …, refcounted and shared across clients; released on session_shutdown when reason === "quit".
    • Inject the directive on before_agent_start (analogue of CC's additionalContext and OpenCode's system.transform), followed by the section on this machine's declared facets (crib facets instructions, asked once per process) when it declares any.
    • /crib <topic> — shells out to the crib CLI (note apropos + code lookup) and steers the model to summarise, mirroring commands/crib.md.

Stand-down when combiner-served

If a combiner already serves crib (the global MCP_COMBINER switch, or the per-backend MCP_COMBINER_SERVES_CRIBSHEET override, which wins), the extension does not launch a standalone backend — the combiner owns crib's lifecycle. The directive and /crib command still apply, since crib's tools are present via the combiner too. In that setup you register the combiner with pi-mcp-adapter (see the mcp-companion Pi extension), not crib directly.

Install

# build
npm --prefix plugins/pi install && npm --prefix plugins/pi run build
# install into Pi (symlink the package dir; uses "main": dist/index.js)
ln -sfn "$PWD/plugins/pi" ~/.pi/agent/extensions/cribsheet
# MCP transport (skip the mcp.json when crib is combiner-served)
pi install npm:pi-mcp-adapter
cp plugins/pi/mcp.json.example ~/.config/mcp/mcp.json   # standalone only

Build-free live dev: pi -e ./plugins/pi/src/index.ts.

Configuration

PI_CRIBSHEET_* env namespace (mirrors the OpenCode plugin's OPENCODE_CRIBSHEET_*):

VariableDefaultEffect
PI_CRIBSHEET_PORT7732HTTP port crib serves on.
PI_CRIBSHEET_HOST127.0.0.1HTTP host crib binds.
PI_CRIBSHEET_COMMAND / _ARGS(auto: crib on PATH)Override the crib invocation.
PI_CRIBSHEET_CHECKOUT—Checkout for uv run --project <checkout> crib.
PI_CRIBSHEET_NAMEcribsheetsharedserver instance name.
PI_CRIBSHEET_GRACE1hsharedserver grace period.
PI_CRIBSHEET_LOG—Capture crib's stdout/stderr (sharedserver --log-file); "none"/unset disables.
PI_CRIBSHEET_MANAGEtruefalse → don't launch (assume crib runs elsewhere).
PI_CRIBSHEET_INSTRUCTIONStruefalse → don't inject the directive.
PI_CRIBSHEET_COMMAND_ENABLEtruefalse → don't register /crib.
PI_CRIBSHEET_NOTIFYtruefalse → don't surface messages via the Pi UI.
MCP_COMBINER / MCP_COMBINER_SERVES_CRIBSHEET—Combiner serves crib → don't launch a standalone backend.
SHAREDSERVER_BIN / SHAREDSERVER_LOCKDIR(auto)sharedserver binary / lock dir.

Development

npm install && npm run typecheck && npm run build

src/sharedserver-resolve.ts is vendored byte-identical from georgeharker/sharedserver via scripts/sync-vendored.sh — edit upstream, re-sync here.

License

MIT © George Harker

版本与发布记录

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

版本发布日期距今
0.25.0latest2026/11/17今天
0.25.0-dev3dev2026/11/17今天
0.25.0-dev22026/11/161 天前
0.25.0-dev12026/11/161 天前
0.24.0-dev42026/11/161 天前
0.24.0-dev32026/11/161 天前

关于 @geohar/pi-cribsheet 的常见问题

@geohar/pi-cribsheet 是什么?

Pi extension: run the crib (cribsheet) memory + code-index MCP server via sharedserver, inject the reach-for-crib directive, and ship the /crib recall command. Pairs with pi-mcp-adapter.

如何安装 @geohar/pi-cribsheet?

在项目目录运行 npm install @geohar/pi-cribsheet,或使用 pnpm add / yarn add / bun add。

@geohar/pi-cribsheet 支持 TypeScript 吗?

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

@geohar/pi-cribsheet 支持 ESM 还是 CommonJS?

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

@geohar/pi-cribsheet 需要什么版本的 Node.js?

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

@geohar/pi-cribsheet 可以商用吗?

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

@geohar/pi-cribsheet 的下载量有多少?

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

@geohar/pi-cribsheet 还在维护吗?

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