engram

Engram

AI コーディングエージェント向けの、ローカルで動作する構造化コードグラフおよびコンテキストツールキットです。Engram はソースコードのエンティティ、Git の関係性、選択したプロジェクトの記憶をインデックス化し、CLI、エージェントフック、MCP、認証付きローカルダッシュボードを通じて、焦点を絞ったコンテキストを提供します。

ファイル全体を読む前に関連コードを見つけたり、関係性を調べたり、記録された間違いを後のセッションに引き継いだりするために使用できます。動作について主張する前に、クエリが返したソースを読んでください。グラフ検索は調査を支援するものです。

クイックスタート

調査対象のパッケージは engramx 4.5.0 で、Node >=20 が必要です。このソースビルドの例は、ソースを調査したものであり、実行していません。現時点で公開されているパッケージや拡張機能のバージョンがあることを前提としていません。

git clone https://github.com/NickCirv/engram.git
cd engram
git checkout 9fa2a4b74ca8e66560d74d1255c16c43157d32bd
npm install --ignore-scripts
npm run build
export ENGRAM_NO_UPDATE_CHECK=1
node dist/cli.js init ../your-project --no-hook
node dist/cli.js query "authentication" --project ../your-project --budget 2000
node dist/cli.js stats --project ../your-project

../your-project を、調査可能なコードベースに置き換えてください。インデックス作成により、プロジェクトの .engram/ グラフが書き込まれます。--no-hook フラグが重要です。デフォルトの CLI init は Sentinel フックもインストールします。まずグラフから始めて、出力を確認してから、どの連携機能を有効にするか決めてください。ビルドには文法のバンドルが含まれます。インストール前にパッケージのスクリプトと依存関係を確認してください。

クエリは、一致したグラフエンティティと推定トークン数、または一致するノードがないことを示すメッセージを返します。件数はインデックス化したプロジェクトによって異なります。ここではベンチマークの出力を捏造していません。

実装済みの機能

ワークフロー	ソースで確認できるエントリーポイント
構造を調べる	query, path, gods, callers, callees, impact, stats
コンテキストを管理する	init, watch, reindex, learn, mistakes
エージェント用ドキュメントを生成する	gen, gen-mdc, gen-aider, gen-windsurfrules, gen-ccs
フック連携を調べる	install-hook --dry-run, hook-preview, hook-stats, hook-disable, hook-enable
コンテキストを提供する	server, ui, engram-serve MCP 実行ファイル
計測結果を確認する	measure, bench, cost, パッケージのベンチマークスクリプト
インストールを管理する	doctor, setup --dry-run, update --check, データベース／キャッシュ／プラグインのコマンド

これらのエントリーポイントは、固定された CLI で宣言されています。書き込み操作の前に、各コマンドのヘルプを確認してください。ジェネレーター、フックインストーラー、キャッシュ／データベース関連のコマンド、プラグインのインストールは、ローカルの状態を変更する可能性があります。

アーキテクチャ

ソースマイナーはエンティティ、参照、Git の共変更、および選択されたエラー／セッション情報を抽出します。グラフストアは sql.js を使用して、プロジェクトごとの SQLite にデータを永続化します。クエリはグラフをたどり、上限付きのコンテキストを生成します。プロバイダーリゾルバーは組み込みソースとオプションのプラグイン／MCP プロバイダーを組み合わせます。インテグレーションは外部プロセスやネットワークアクセスを追加できます。

アーキテクチャおよびインテグレーションガイドでは、これらの経路を図示し、HTTP 認証について説明するとともに、ローカル MCP 設定を示しています。既存の設計記録、リリースノート、インテグレーション文書、ECP ドラフトは、ドキュメント一覧から引き続き参照できます。これらは過去の背景を保つものであり、すべてがこのリビジョンに照らして認証済みというわけではありません。

プライバシーと運用上の境界

コアグラフはローカルにありますが、システム全体がネットワークに接続しないことは保証されません。CLI は npm の更新チェックを行い、Context7 は外部ラッパーを呼び出すことがあり、設定済みの MCP／プラグインプロバイダーは独自のプロセスを実行できます。ENGRAM_NO_UPDATE_CHECK=1 を設定すると更新チェックの経路は無効になりますが、すべてのオプションのインテグレーションが無効になるわけではありません。設定済みのプロバイダーと、グラフ出力を受け取るエージェントを確認してください。

HTTP サーバーは 127.0.0.1 にバインドし、Host／Origin を検証します。また、保護されたルートへのアクセスにはベアラートークンまたはダッシュボード Cookie が必要です。トークンは ENGRAM_API_TOKEN またはローカルのトークンファイルから解決されます。このトークンは非公開にし、既存のセキュリティポリシーを引き続き遵守してください。

制限と測定

構造化されたコンテキストのサイズ、推定トークン削減量、セッションのリプレイ、実際のプロバイダー料金は、それぞれ異なる問いに答えるものです。パケットが小さくなっただけでは、回答品質が同等であることや料金が低くなることは示せません。付属のベンチマークを、ご自身の代表的なワークロードで再現し、コストとともに正確性も追跡してください。このドキュメントのレビューでは、ビルド、テストスイート、ベンチマーク、エージェントセッションのいずれも実行していません。

開発

npm run build
npm run lint
npm test -- --run

リポジトリには、グラフストレージ、プロバイダー、フック、HTTP セキュリティ、その他のモジュールに関するユニットテストおよびインテグレーションテストのソースが含まれています。これらの存在はテストカバレッジを意図していることを示すものですが、このリビジョンでの結果はここでは検証されていません。動作を変更する前に、保存されている貢献ガイドを確認してください。

ライセンスと作者

Apache-2.0 ライセンス。ECP 仕様には、原文書に独自の帰属表示とライセンスが記載されています。この改稿によって、いずれも変更されることはありません。

Nicholas Ashkar · 応用 AI、システム、コンサルティング。

ユーザーガイド

ユーザーマニュアルでは、セットアップ、スキル、トラブルシューティング、削除について説明しています。Sentinelでは、現在のフックの動作とガードモードについて説明しています。ツールの作成者はインテグレーションガイドを利用できます。