luxusai-pi-hindsight

内容来源:README.md(说明文档) · 原始地址 · 查看安装指南

原始内容

Pi Hindsight

Pi Hindsight Extension

Persistent memory for Pi backed by Hindsight.

Documentation: https://luxus.github.io/pi-hindsight/

Pi Hindsight recalls relevant project memory before model calls, retains structured session deltas after completed agent runs, and exposes explicit memory tools for direct retain/recall/reflect operations.

Install

Install the published npm package:

pi install npm:@luxusai/pi-hindsight

You can still install from GitHub when you want the current repository source instead of the latest npm release:

pi install https://github.com/luxus/pi-hindsight

Package name: @luxusai/pi-hindsight.

For local checkout installs, see Development.

Quick start

  1. Start or choose a Hindsight server:
  2. Open Pi in your repo and run /hindsight.
  3. Configure the Hindsight API URL. The default self-hosted URL is http://localhost:8888.
  4. Choose the narrowest memory profile that fits the repo: Project + User, Project Only, User Only, or Recall Only.
  5. Start coding. Recall happens before provider calls; retain happens after completed agent runs when the selected profile allows automatic retain.

See the getting started guide for setup details. Upgrading from older path-bank installs: Upgrading to domain banks.

Safety defaults

  • Project memory stays in a project bank by default.
  • User memory is opt-in and explicitly configured.
  • Recall injection is ephemeral; recalled memory is not written back into transcripts.
  • Automatic retain redacts common secrets before writing memory.
  • Exact document deletion requires exact bank ID, exact document ID, and confirm: true.

See memory behavior and session memory modes for details.

Documentation

  • Start — install and first setup
  • Concepts — memory model, banks, queue, imports, safety
  • Guides — task workflows for setup, diagnostics, imports, recovery, and domain-bank upgrades
  • Reference — tools, commands, config, hooks, generated surface
  • Development — contributor setup, checks, release, docs workflow

Development

npm install
npm run check

npm run check includes npm run docs:check, which verifies generated surface-reference freshness, generated code-map freshness, internal docs links/sidebar routes, packaged Markdown links, GitHub Pages base-prefixed docs links, and docs-site build.

Run Pi with the local extension:

pi -e ./extensions/index.ts

Install a local checkout into Pi when you need to test package loading from your working tree:

pi install /path/to/pi-hindsight

For maintainer details, see Development setup and Release process.

Prior art

Pi Hindsight is inspired by noctuid/pi-hindsight. This package keeps the same useful idea, then tightens project isolation, queue durability, diagnostics, and release hardening.