# Hindsight Companion

[English](../README.md)

在 Pi 和 PiWeb 中使用 [Hindsight](https://github.com/vectorize-io/hindsight) 长期记忆，并通过 Windows 托盘管理 Hindsight 服务。

- **Pi / PiWeb 插件包**：将官方 Hindsight 扩展及配套 Skill 接入 Pi 的插件管理。
- **Windows 托盘**：为已有的原生 CUDA 部署提供 API 和 Control Plane 的启动、停止与更新入口。

两个组件可独立使用。插件更新与前后端更新分别操作。

## 安装 Pi 插件

需要 Node.js 22+、Pi，以及可访问的 Hindsight 服务。

```sh
pi install npm:pi-hindsight-companion
```

也可在 PiWeb「设置 → 插件 → 添加插件」中输入 `npm:pi-hindsight-companion`。

安装后启动或重载 Pi。全新环境首次加载时，插件会在 `~/.pi/agent/hindsight.json` 生成禁用状态的配置模板。填写服务地址、API 令牌和记忆库，将 `disabled` 改为 `false`，然后重载 Pi。详见[连接配置](CONFIGURATION.zh-CN.md)。

在 PiWeb「设置 → 插件」中可启用或禁用插件包。切换后重载目标会话，使设置生效。

### 使用项目记忆库

在项目目录中打开会话，执行 `/hindsight-project`。Companion 会添加官方目录到记忆库的映射并重载 Pi，无需手工填写路径。自定义记忆库 ID 和 `personal` 默认库设置见[登记当前项目](CONFIGURATION.zh-CN.md#登记当前项目)。

### 更新插件

在 PiWeb 中点击「检查 / 更新」，或执行：

```sh
pi update --extensions
```

更新后重载会话。更新内容包含最新 Companion 发行版及其指定的官方运行版本。官方运行版本的更新随 Companion 发行版提供。

## 安装 Windows 托盘

托盘使用已有的 CUDA API 环境、Control Plane 和内嵌 PostgreSQL。按 [Windows 安装与恢复](../windows/README.zh-CN.md)安装管理脚本及开始菜单快捷方式。

托盘菜单提供：

- **启动前后端**：启动 API 和 Control Plane。
- **停止前后端（释放显存）**：停止服务及内嵌数据库。
- **检查并更新前后端…**：备份并更新服务端组件。

管理页面地址：<http://127.0.0.1:9999>。

## 文档

- [连接配置](CONFIGURATION.zh-CN.md)
- [Windows 安装与恢复](../windows/README.zh-CN.md)
- [开发与发布](RELEASING.zh-CN.md)
- [安全说明](../SECURITY.zh-CN.md)
- [更新日志](../CHANGELOG.zh-CN.md)

本项目采用 MIT 许可证，是基于 Vectorize Hindsight 的社区工具。依赖归属见 [NOTICE](../NOTICE)，[中文说明](NOTICE.zh-CN.md)。