kiokuko 1.0.43 → 1.0.44

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/README.ja.md +21 -159
  2. package/README.ko.md +21 -125
  3. package/README.md +21 -196
  4. package/README.zh-CN.md +21 -126
  5. package/dist/assurance/contracts.d.ts +1 -1
  6. package/dist/assurance/doctor.d.ts +1 -1
  7. package/dist/assurance/inspect.d.ts +1 -1
  8. package/dist/assurance/service.d.ts +1 -1
  9. package/dist/assurance/verification-contracts.d.ts +1 -1
  10. package/dist/assurance/verification.d.ts +1 -1
  11. package/dist/cli.d.ts.map +1 -1
  12. package/dist/cli.js +43 -5
  13. package/dist/cli.js.map +1 -1
  14. package/dist/commands/code-version.d.ts +6 -0
  15. package/dist/commands/code-version.d.ts.map +1 -0
  16. package/dist/commands/code-version.js +66 -0
  17. package/dist/commands/code-version.js.map +1 -0
  18. package/dist/commands/doctor.d.ts +12 -1
  19. package/dist/commands/doctor.d.ts.map +1 -1
  20. package/dist/commands/doctor.js +75 -30
  21. package/dist/commands/doctor.js.map +1 -1
  22. package/dist/ledger/checkpoint-contract.d.ts +8 -8
  23. package/dist/mcp/chatgpt-contract.d.ts +1 -1
  24. package/dist/mcp/request-deadline.d.ts +1 -1
  25. package/dist/mcp/request-deadline.d.ts.map +1 -1
  26. package/dist/mcp/request-deadline.js +1 -0
  27. package/dist/mcp/request-deadline.js.map +1 -1
  28. package/dist/mcp/server.d.ts.map +1 -1
  29. package/dist/mcp/server.js +42 -0
  30. package/dist/mcp/server.js.map +1 -1
  31. package/dist/memory/applicability-context.d.ts +24 -0
  32. package/dist/memory/applicability-context.d.ts.map +1 -0
  33. package/dist/memory/applicability-context.js +129 -0
  34. package/dist/memory/applicability-context.js.map +1 -0
  35. package/dist/memory/checkpoint-contract.d.ts +42 -12
  36. package/dist/memory/checkpoint-contract.d.ts.map +1 -1
  37. package/dist/memory/checkpoint-contract.js +5 -0
  38. package/dist/memory/checkpoint-contract.js.map +1 -1
  39. package/dist/memory/code-versions.d.ts +79 -0
  40. package/dist/memory/code-versions.d.ts.map +1 -0
  41. package/dist/memory/code-versions.js +159 -0
  42. package/dist/memory/code-versions.js.map +1 -0
  43. package/dist/memory/entry-history.d.ts +29 -0
  44. package/dist/memory/entry-history.d.ts.map +1 -0
  45. package/dist/memory/entry-history.js +66 -0
  46. package/dist/memory/entry-history.js.map +1 -0
  47. package/dist/memory/federated-retrieval.d.ts.map +1 -1
  48. package/dist/memory/federated-retrieval.js +14 -1
  49. package/dist/memory/federated-retrieval.js.map +1 -1
  50. package/dist/memory/handoff.d.ts +1 -1
  51. package/dist/memory/history-delivery.d.ts +57 -0
  52. package/dist/memory/history-delivery.d.ts.map +1 -0
  53. package/dist/memory/history-delivery.js +85 -0
  54. package/dist/memory/history-delivery.js.map +1 -0
  55. package/dist/memory/hybrid-retrieval.d.ts +5 -0
  56. package/dist/memory/hybrid-retrieval.d.ts.map +1 -1
  57. package/dist/memory/hybrid-retrieval.js +28 -9
  58. package/dist/memory/hybrid-retrieval.js.map +1 -1
  59. package/dist/memory/interaction-contract.d.ts +22 -12
  60. package/dist/memory/interaction-contract.d.ts.map +1 -1
  61. package/dist/memory/lesson-derivation.d.ts +1 -1
  62. package/dist/memory/lifecycle.d.ts.map +1 -1
  63. package/dist/memory/lifecycle.js +18 -1
  64. package/dist/memory/lifecycle.js.map +1 -1
  65. package/dist/memory/observation-contract.d.ts +4 -4
  66. package/dist/memory/retrieval.d.ts +11 -0
  67. package/dist/memory/retrieval.d.ts.map +1 -1
  68. package/dist/memory/retrieval.js +11 -6
  69. package/dist/memory/retrieval.js.map +1 -1
  70. package/dist/memory/structured-memory.d.ts +5 -0
  71. package/dist/memory/structured-memory.d.ts.map +1 -1
  72. package/dist/memory/structured-memory.js +28 -6
  73. package/dist/memory/structured-memory.js.map +1 -1
  74. package/docs/README.ja.md +2 -0
  75. package/docs/README.md +2 -0
  76. package/docs/cli-contract.md +24 -5
  77. package/docs/context-delivery.md +7 -0
  78. package/docs/getting-started.ja.md +8 -5
  79. package/docs/getting-started.md +11 -8
  80. package/docs/history-evidence.md +139 -0
  81. package/docs/setup-notes.ja.md +122 -0
  82. package/docs/setup-notes.ko.md +107 -0
  83. package/docs/setup-notes.md +133 -0
  84. package/docs/setup-notes.zh-CN.md +107 -0
  85. package/migrations/014_code_version_evidence.sql +26 -0
  86. package/package.json +1 -1
package/README.ja.md CHANGED
@@ -1,177 +1,39 @@
1
1
  # Kiokuko(記憶庫)
2
2
 
3
- 1.0では旧DBを利用できません。新規DBで開始してください。[破壊的変更と旧設定の撤去手順](docs/breaking-changes-1.0.md)を参照してください。
4
-
5
3
  [English](README.md) | 日本語 | [简体中文](README.zh-CN.md) | [한국어](README.ko.md)
6
4
 
7
- **MCPで接続し、必要な記憶を検索し、作業後に知識を蓄積する。**
8
-
9
- KiokukoはAIコーディングエージェント向けのローカル外部メモリです。SQLiteに知識を保存し、
10
- 次のタスクに関係する文脈を検索し、作業結果から再利用できる知識を記録します。
5
+ AIエージェント用のローカルメモリです。好み・判断・訂正をSQLiteに保存し、
6
+ 必要な文脈をMCP経由で検索します。
11
7
 
12
- ## 基本概念
13
-
14
- ```text
15
- 依頼 → MCP接続 → 関係する記憶を検索 → 作業
16
- ↓
17
- 再利用できる知識を保存
18
- ```
8
+ **Codex・OpenCode・Claude Code・Hermes Agent**に対応。
9
+ [ChatGPTへの接続はプレビュー版です](docs/setup-notes.ja.md#chatgpt)。
19
10
 
20
- 記憶はProject・Ecosystem・Globalに分離されます。現在のコード、設定、実行結果が過去の記憶より優先されます。
11
+ ## インストール
21
12
 
22
- ## 最短セットアップ
23
-
24
- Node.js 24.16.0以上が必要です(Node.js 26.1.0以上にも対応)。
13
+ Node.js **24.16.0以上**が必要です。
25
14
 
26
15
  ```bash
27
- npm install --global kiokuko
16
+ npm i -g kiokuko
28
17
  kiokuko setup
29
18
  ```
30
19
 
31
- `setup`はローカルDB・標準Skill・MCP接続に加えて、ローカルsemantic検索も設定します。
32
- 初回は埋め込みランタイムとモデルを導入します。
33
- 起動中のクライアントは、設定後に一度再起動してください。正確な設定規則は
34
- [導入ガイド](docs/getting-started.ja.md)を参照してください。
35
-
36
- 埋め込みランタイムとモデルを導入せず、クライアント設定だけ行う場合:
20
+ クライアントを再起動すれば、あとは普段どおり使えます。MCP・標準Skill・
21
+ ローカルsemantic検索を設定します。埋め込みモデルのダウンロードを省く場合は
22
+ `kiokuko setup --no-embeddings`を使ってください。
37
23
 
38
- ```bash
39
- kiokuko setup --no-embeddings
40
- ```
24
+ 1.0未満からの更新には新規DBが必要です。
25
+ [移行と旧設定の撤去](docs/breaking-changes-1.0.md)。
41
26
 
42
- 埋め込みのセットアップを省略します。既存の埋め込み設定は変更しません。
27
+ ## ドキュメント
43
28
 
44
29
  <a id="setup-messages"></a>
45
30
 
46
- ### npmの通知とセットアップエラー
47
-
48
- `install scripts not yet covered by allowScripts`は、依存パッケージのスクリプトに実行許可が記録されていないという通知です。
49
- `esbuild`はビルドツール、`fsevents`はmacOSのファイル監視用です。この通知だけではセットアップの失敗とは限りません。
50
-
51
- 通知が出たパッケージのディレクトリで確認します。
52
-
53
- ```bash
54
- npm install-scripts ls
55
- ```
56
-
57
- `esbuild`と`fsevents`が表示され、スクリプトを確認したうえで実行を許可する場合は、次のコマンドで記録します。
58
-
59
- ```bash
60
- npm install-scripts approve esbuild fsevents
61
- ```
62
-
63
- 許可はそのディレクトリの`package.json`に保存されます。macOSでKiokukoをグローバルインストールした場合は、エラーに表示されたKiokukoのインストール先で実行してください。
64
- 別のプロジェクトで実行すると、そのプロジェクトの許可設定を確認・変更します。
65
- 詳しくは[npmのスクリプト許可ガイド](https://docs.npmjs.com/cli/v11/commands/npm-install-scripts/)を参照してください。
66
-
67
- 最後に`Local semantic retrieval dependencies remain unavailable`と`Cannot find package ... @huggingface/hub/index.js`が出た場合は、
68
- 埋め込みランタイムを読み込めず、semantic検索の設定が完了していません。スクリプトの許可でこの読み込みエラーが直るとは確認できていません。
69
- 問い合わせる際は、エラー全文と`kiokuko --version`、`node --version`、`npm --version`の結果を添えてください。
70
-
71
- ### Codex用の保存済み実行版
72
-
73
- npmの導入先が置き換わってもCodexのMCPとライフサイクルhookを同じ版で動かすには、ユーザー専用のアプリケーションデータ領域に実行版を用意します。進行中の作業を終え、Codexを停止してから設定を切り替えてください。
74
-
75
- ```bash
76
- kiokuko runtime-prepare --runtime-root "$HOME/Library/Application Support/Kiokuko/runtimes" --json
77
- kiokuko setup --clients codex --no-embeddings --no-standard-skills --runtime-manifest /absolute/path/to/runtime/manifest.json --client-stopped
78
- kiokuko runtime-diagnose --manifest /absolute/path/to/runtime/manifest.json --json
79
- ```
80
-
81
- Linuxでは実行版の保存先に`${XDG_DATA_HOME:-$HOME/.local/share}/kiokuko/runtimes`を使います。2行目と3行目のmanifestは、1行目が返す`manifestPath`に置き換えます。現在のNodeがバイナリ外の共有ライブラリに依存する場合、準備は失敗します。その場合は`--node /absolute/path/to/node`で単独起動できるNodeを指定してください。準備だけではクライアント設定は変わりません。`setup`は保存したファイルを検証し、管理対象のMCPと全hookを同じ版へ更新します。途中で失敗した設定ファイルは元に戻します。診断結果が`readyForRestart: true`になってからCodexを再起動してください。独自のMCP起動コマンドは保持され、別途移行が必要です。
82
-
83
- npmを更新しただけでは使用版は切り替わりません。更新時は作業を終えてCodexを停止し、新版を準備して、そのmanifestで`setup`を実行してから再起動します。旧実行版は自動削除しません。新版がメモリDBをmigrationした後に旧版へ戻す場合は、先にDB互換性を確認してください。保存容量はNodeと導入済みの任意依存によって変わりますが、1版につき数百MBを見込み、複数版を残す前に実際の容量を確認してください。
84
-
85
- ## アンインストール
86
-
87
- Kiokukoを使うクライアントと`kiokuko serve`を終了してから実行します。
88
-
89
- ```bash
90
- kiokuko uninstall --dry-run
91
- kiokuko uninstall
92
- # 全エージェントを選択して正常終了後、最後に表示されたコマンドを実行
93
- npm uninstall --global kiokuko
94
- ```
95
-
96
- ↑↓で移動、Spaceで選択を切り替え、Enterで確定、Escで中止します。初期状態は未選択です。
97
- 選択したエージェントの管理設定・Skillだけを削除します。**全4エージェントを選ぶと記憶DB・埋め込みモデル・登録済みプロジェクトの管理部分も削除**し、最後にnpmの削除コマンドを表示します。一部だけを選んだ場合は共有データとnpmパッケージを残します。ユーザーが書いた内容は保持します。
98
- スクリプトでは `kiokuko uninstall --clients opencode,claude`、完全削除には `kiokuko uninstall --all` を使います。
99
- 独自の配置先を指定していた場合は、セットアップ時と同じ環境変数で実行してください。[削除範囲と失敗時の扱い](docs/cli-contract.md#uninstall)
100
-
101
- ## 主な機能
102
-
103
- - **RAGメモリ**: lexical検索に加え、`setup`でローカルsemantic検索を設定。
104
- - **Akinator**: 曖昧な依頼を作業前に具体化。
105
- - **ローカルWeb UI**: 保存した記憶の確認と整理。
106
- - **参照専用Skill**: 外部Skillは検証して保存するが、自動実行しない。
107
-
108
- `kiokuko embeddings setup`は、`kiokuko setup`と同じ処理を行う互換コマンドとして利用できます。
109
-
110
- managed MCP blockと登録済みプロジェクトのinstructionsを更新します。unmanaged identityの置換は対話確認後だけ行い、
111
- 非対話または`--dry-run --json`では変更せずfail closedします。詳細は
112
- [semantic retrievalガイド](docs/semantic-retrieval.ja.md)を参照してください。
113
-
114
- ## 対応クライアント
115
-
116
- Codex、OpenCode、Claude Code、Hermes Agentに対応しています。client別の設定、再起動、Web UIは
117
- [導入ガイド](docs/getting-started.ja.md)にまとめています。
118
-
119
- セッションの記録には[AgenticReplay](docs/agenticreplay.ja.md)を使い、Kiokukoに接続する
120
- クライアントをレコーダーから起動します。任意で使うツールで、別途インストールします。
121
-
122
- ## ChatGPTで使う(プレビュー)
123
-
124
- Developer modeで自分用プラグインとして接続し、記憶を保存・検索します。ストア配布版はありません。
125
-
126
- 1. **Kiokukoを準備する。** `kiokuko mcp --help`に`--profile`と`--access`がある版を使います。なければ[ソース版を導入](docs/chatgpt.ja.md)。DBが未作成なら`kiokuko init`を実行します。
127
- 2. **Tunnelクライアントを入れる。** macOSでは[公式Homebrew手順](https://github.com/openai/tunnel-client#install-with-homebrew)でインストールします。
128
-
129
- ```bash
130
- brew install openai/tools/tunnel-client
131
- tunnel-client --version
132
- ```
133
-
134
- 他のOSは[公式配布先](https://github.com/openai/tunnel-client/releases/latest)を参照。[Tunnel設定](https://platform.openai.com/settings/organization/tunnels)で利用するChatGPT workspaceに関連付けたTunnel IDと、Tunnels Read + Use権限の[実行用APIキー](https://platform.openai.com/settings/organization/api-keys)を用意します。
135
-
136
- 3. **手元のPCで接続を起動する。** `<tunnel_id>`と`<runtime_api_key>`を取得した値に置き換えます。
137
-
138
- ```bash
139
- export CONTROL_PLANE_API_KEY="<runtime_api_key>"
140
- tunnel-client init \
141
- --sample sample_mcp_stdio_local \
142
- --profile kiokuko-chatgpt \
143
- --tunnel-id "<tunnel_id>" \
144
- --mcp-command "kiokuko mcp --profile chatgpt-memory --access read-write"
145
- tunnel-client doctor --profile kiokuko-chatgpt --explain
146
- kiokuko chatgpt run --profile kiokuko-chatgpt
147
- ```
148
-
149
- 利用中は起動したままにします。別の端末で起動する場合はAPIキーを再設定し、最後の`run`を実行します。
150
-
151
- 4. **ChatGPTに登録する。** 設定 → **Security and login → Developer mode**を有効化。**Plugins → +**で名前を`Kiokuko`、説明を「記憶の保存と検索」にし、**Connection → Tunnel**で同じIDを指定します。新しい会話のツールメニューからKiokukoを選びます。[公式の画面手順](https://developers.openai.com/plugins/deploy/connect-chatgpt)
152
-
153
- 使い方: 「この内容をKiokukoに保存して」「Kiokukoから○○についての記憶を探して」。書き込み確認が出たら内容を確認して承認します。
154
-
155
- 検索だけなら起動コマンドの`read-write`を`read`に変更します。ChatGPT標準メモリの保存先は変わりません。**ChatGPT実機での接続確認は未実施**です。[困ったとき](docs/chatgpt.ja.md)
156
-
157
- ## 安全性と制約
158
-
159
- 会話全文は保存せず、パスワード、API key、token、秘密鍵に似た内容を拒否します。保存された記憶は参考情報であり、
160
- 現在のリポジトリと実行結果で確認してください。
161
-
162
- MCPの利用はclientとモデルが決めるため、**毎回必ずKiokukoが呼ばれる保証はありません**。信頼境界と公開エラーは
163
- [Security and trust](docs/security-and-trust.ja.md)で説明しています。
164
-
165
- ## 詳細ドキュメント
166
-
167
- - [ドキュメント目次](docs/README.ja.md)
168
31
  - [導入ガイド](docs/getting-started.ja.md)
169
- - [基本概念](docs/concepts.ja.md)
170
- - [Semantic retrieval](docs/semantic-retrieval.ja.md)
171
- - [Akinator のプロフィール補助](docs/akinator-memory.md)
172
- - [記憶の適用記録・検証結果・Codex フック](docs/memory-assurance.md)
173
- - [Security and trust](docs/security-and-trust.ja.md)
174
- - [CLI contract](docs/cli-contract.md)
175
-
176
- 実装者向け資料は[architecture](docs/architecture.md)、[database](docs/database.md)、[execution ledger](docs/execution-ledger.md)、
177
- [client compatibility](docs/client-compatibility.md)を参照してください。
32
+ - [設定・トラブルシューティング・アンインストール](docs/setup-notes.ja.md)
33
+ - [記憶と検索](docs/concepts.ja.md)
34
+ - [履歴とコードの証拠(英語)](docs/history-evidence.md)
35
+ - [ドキュメント一覧](docs/README.ja.md)
36
+
37
+ 保存した記憶には誤りがありえます。秘密情報に見える内容は拒否し、会話全文は保存しません。
38
+ MCPの呼び出しはクライアントとモデルの判断に依存します。
39
+ [安全性と信頼の境界](docs/security-and-trust.ja.md)。
package/README.ko.md CHANGED
@@ -1,143 +1,39 @@
1
1
  # Kiokuko (記憶庫)
2
2
 
3
- 1.0에서는 기존 DB를 지원하지 않습니다. 새 DB를 사용하세요. [주요 변경 사항과 이전 설정 제거](docs/breaking-changes-1.0.md)를 확인하세요。
4
-
5
3
  [English](README.md) | [日本語](README.ja.md) | [简体中文](README.zh-CN.md) | 한국어
6
4
 
7
- **MCP로 연결하고, 필요한 기억을 검색하고, 작업 후 지식을 축적합니다.**
8
-
9
- Kiokuko는 AI 코딩 에이전트를 위한 로컬 외부 메모리입니다. 지식을 SQLite에 저장하고 다음 작업에 관련된 문맥을 검색하며,
10
- 재사용 가능한 결과를 기록합니다.
11
-
12
- ```text
13
- 요청 → MCP 연결 → 관련 기억 검색 → 작업 수행
14
- ↓
15
- 재사용 지식 저장
16
- ```
5
+ AI 에이전트를 위한 로컬 메모리입니다. 선호 사항, 결정, 수정 내용을 SQLite에
6
+ 저장하고 MCP를 통해 관련 문맥을 검색합니다.
17
7
 
18
- 기억은 Project·Ecosystem·Global로 분리되고 현재 코드, 설정, 실행 결과가 과거 기억보다 우선합니다.
8
+ **Codex, OpenCode, Claude Code, Hermes Agent**를 지원합니다.
9
+ [ChatGPT 연결은 미리 보기 버전입니다](docs/setup-notes.ko.md#chatgpt).
19
10
 
20
- ## 빠른 시작
11
+ ## 설치
21
12
 
22
- Node.js 24.16.0 이상이 필요합니다(Node.js 26.1.0 이상도 지원).
13
+ Node.js **24.16.0 이상**이 필요합니다.
23
14
 
24
15
  ```bash
25
- npm install --global kiokuko
16
+ npm i -g kiokuko
26
17
  kiokuko setup
27
18
  ```
28
19
 
29
- `setup`은 데이터베이스, 표준 Skill, MCP 연결과 로컬 semantic 검색을 설정합니다.
30
- 처음 실행할 때 임베딩 런타임과 모델을 설치합니다. 이미 실행 중인 클라이언트는
31
- 설정 후 재시작하십시오. 정확한 규칙은 [영문 Getting started](docs/getting-started.md)를 참조하십시오.
32
-
33
- 임베딩 런타임과 모델을 설치하지 않고 클라이언트만 설정하려면:
20
+ 클라이언트를 재시작한 뒤 평소대로 사용하세요. MCP, 표준 Skill, 로컬 semantic
21
+ 검색이 설정됩니다. 임베딩 다운로드를 건너뛰려면
22
+ `kiokuko setup --no-embeddings`를 사용하세요.
34
23
 
35
- ```bash
36
- kiokuko setup --no-embeddings
37
- ```
24
+ 1.0 이전 버전에서 업데이트하려면 새 데이터베이스가 필요합니다.
25
+ [마이그레이션 및 이전 설정 정리](docs/breaking-changes-1.0.md).
38
26
 
39
- 임베딩 설정 단계를 건너뛰며 기존 임베딩 설정은 변경하지 않습니다.
27
+ ## 문서
40
28
 
41
29
  <a id="setup-messages"></a>
42
30
 
43
- ### npm 알림과 설정 오류
44
-
45
- `install scripts not yet covered by allowScripts`는 해당 의존성 스크립트의 실행 승인이 npm에 기록되지 않았다는 뜻입니다.
46
- `esbuild`는 빌드 도구이고, `fsevents`는 macOS 파일 감시에 사용됩니다. 이 알림만으로 설정이 실패했다고 볼 수는 없습니다.
47
-
48
- 알림이 발생한 패키지 디렉터리에서 확인하세요.
49
-
50
- ```bash
51
- npm install-scripts ls
52
- ```
53
-
54
- `esbuild`와 `fsevents`가 표시되고, 스크립트를 검토한 뒤 실행을 허용하려면 다음 명령으로 승인을 기록하세요.
55
-
56
- ```bash
57
- npm install-scripts approve esbuild fsevents
58
- ```
59
-
60
- 승인은 해당 디렉터리의 `package.json`에 저장됩니다. macOS에 Kiokuko를 전역 설치했다면 오류에 표시된 Kiokuko 설치 디렉터리에서 실행하세요.
61
- 다른 프로젝트에서 실행하면 그 프로젝트의 승인 설정을 조회하고 변경합니다.
62
- 자세한 내용은 [npm 스크립트 승인 안내](https://docs.npmjs.com/cli/v11/commands/npm-install-scripts/)를 참조하세요.
63
-
64
- 설정이 `Local semantic retrieval dependencies remain unavailable`과 `Cannot find package ... @huggingface/hub/index.js`로 끝나면,
65
- 임베딩 런타임을 불러오지 못해 semantic 검색 설정이 완료되지 않은 상태입니다. 스크립트 승인으로 이 불러오기 오류가 해결되는지는 확인되지 않았습니다.
66
- 도움을 요청할 때는 전체 오류와 `kiokuko --version`, `node --version`, `npm --version`의 출력을 첨부하세요.
67
-
68
- ## 제거
69
-
70
- Kiokuko를 사용하는 클라이언트와 `kiokuko serve`를 먼저 종료하세요.
71
-
72
- ```bash
73
- kiokuko uninstall --dry-run
74
- kiokuko uninstall
75
- # 모든 에이전트를 선택하고 정리가 완료되면 표시된 명령을 실행합니다:
76
- npm uninstall --global kiokuko
77
- ```
78
-
79
- ↑↓로 이동하고 Space로 선택을 전환하며 Enter로 확정하고 Esc로 취소합니다. 처음에는 모두 선택 해제되어 있습니다.
80
- 선택한 에이전트의 관리 설정과 Skill을 제거합니다. **4개 에이전트를 모두 선택하면 기억 DB, 임베딩 모델, 프로젝트 연결도 삭제**하고 npm 제거 명령을 표시합니다. 일부만 선택하면 공유 데이터와 npm 패키지를 유지합니다. 사용자 내용은 보존합니다.
81
- 스크립트에서는 `kiokuko uninstall --clients opencode,claude`, 완전 제거에는 `kiokuko uninstall --all`을 사용하세요. 사용자 지정 경로는 setup과 같은 환경 변수로 실행하세요.
82
- [삭제 범위](docs/cli-contract.md#uninstall)를 참고하세요.
83
-
84
- ## 주요 기능
85
-
86
- - RAG 기억(lexical 검색과 `setup`으로 구성하는 로컬 semantic 검색)
87
- - 모호한 요청을 구체화하는 Akinator
88
- - 기억을 검토하는 로컬 Web UI
89
- - 자동 실행하지 않는 검증된 참조 전용 External Skill
90
-
91
- `kiokuko embeddings setup`은 `kiokuko setup`과 동일한 처리를 하는 호환 명령으로 유지됩니다.
92
-
93
- managed MCP block과 프로젝트 instructions를 갱신합니다. unmanaged identity 교체는 대화형 확인 후에만 수행되며,
94
- 비대화형 또는 `--dry-run --json` 실행은 변경 없이 fail closed합니다. 자세한 내용은 [영문 semantic retrieval](docs/semantic-retrieval.md)을 보십시오.
95
-
96
- ## 지원 클라이언트
97
-
98
- Codex, OpenCode, Claude Code, Hermes Agent.
99
-
100
- ## ChatGPT에서 사용하기(미리 보기)
101
-
102
- Developer mode에서 개인용 플러그인으로 연결해 기억을 저장하고 검색합니다. 스토어 배포 버전은 없습니다.
103
-
104
- 1. **Kiokuko를 준비합니다.** `kiokuko mcp --help`에 `--profile`과 `--access`가 있는 버전을 사용합니다. 없다면 [소스에서 설치](docs/chatgpt.md)합니다. DB가 없으면 `kiokuko init`을 실행합니다.
105
- 2. **Tunnel 클라이언트를 설치합니다.** macOS에서는 [공식 Homebrew 설치 방법](https://github.com/openai/tunnel-client#install-with-homebrew)을 사용합니다.
106
-
107
- ```bash
108
- brew install openai/tools/tunnel-client
109
- tunnel-client --version
110
- ```
111
-
112
- 다른 OS는 [공식 배포 페이지](https://github.com/openai/tunnel-client/releases/latest)를 참고합니다. [Tunnel 설정](https://platform.openai.com/settings/organization/tunnels)에서 ChatGPT workspace에 연결된 Tunnel ID와 Tunnels Read + Use 권한이 있는 [실행용 API 키](https://platform.openai.com/settings/organization/api-keys)를 준비합니다.
113
-
114
- 3. **컴퓨터에서 연결을 시작합니다.** `<tunnel_id>`와 `<runtime_api_key>`를 발급받은 값으로 바꿉니다.
115
-
116
- ```bash
117
- export CONTROL_PLANE_API_KEY="<runtime_api_key>"
118
- tunnel-client init \
119
- --sample sample_mcp_stdio_local \
120
- --profile kiokuko-chatgpt \
121
- --tunnel-id "<tunnel_id>" \
122
- --mcp-command "kiokuko mcp --profile chatgpt-memory --access read-write"
123
- tunnel-client doctor --profile kiokuko-chatgpt --explain
124
- kiokuko chatgpt run --profile kiokuko-chatgpt
125
- ```
126
-
127
- 사용하는 동안 계속 실행해 둡니다. 새 터미널에서는 API 키를 다시 설정한 뒤 마지막 `run` 명령을 실행합니다.
128
-
129
- 4. **ChatGPT에 등록합니다.** **Settings → Security and login → Developer mode**를 켭니다. **Plugins → +**에서 이름을 `Kiokuko`, 설명을 “기억 저장 및 검색”으로 입력하고 **Connection → Tunnel**에 같은 ID를 지정합니다. 새 대화의 도구 메뉴에서 Kiokuko를 선택합니다. [공식 화면 안내](https://developers.openai.com/plugins/deploy/connect-chatgpt)
130
-
131
- 사용 예: “이 내용을 Kiokuko에 저장해 줘” 또는 “Kiokuko에서 [주제]에 관한 기억을 찾아 줘”. 쓰기 확인이 나오면 내용을 확인하고 승인합니다.
132
-
133
- 검색만 사용하려면 실행 명령의 `read-write`를 `read`로 바꿉니다. ChatGPT 기본 메모리의 저장소는 바뀌지 않습니다. **ChatGPT 실제 연결 시험은 아직 하지 않았습니다.** [문제 해결](docs/chatgpt.md)
134
-
135
- ## 안전성과 제한
136
-
137
- 전체 대화를 저장하지 않으며 비밀번호, API key, token, private key처럼 보이는 내용은 거부합니다. 기억은 참고 정보이므로 현재 코드와 실행 결과를 확인하십시오.
138
-
139
- MCP 호출 여부는 클라이언트와 모델이 결정하므로 **모든 턴에서 Kiokuko가 호출된다는 보장은 없습니다**. 자세한 신뢰 경계는 [영문 Security and trust](docs/security-and-trust.md)를 참조하십시오.
140
-
141
- ## 자세한 문서
31
+ - [시작하기 (영문)](docs/getting-started.md)
32
+ - [설정, 문제 해결 및 제거](docs/setup-notes.ko.md)
33
+ - [메모리와 검색 (영문)](docs/concepts.md)
34
+ - [이력과 코드 증거 (영문)](docs/history-evidence.md)
35
+ - [전체 문서 (영문)](docs/README.md)
142
36
 
143
- [영문 문서 목차](docs/README.md)에서 Getting started, Concepts, Semantic retrieval, Security and trust와 구현자용 문서로 이동할 수 있습니다.
37
+ 저장된 기억은 틀릴 수 있습니다. 비밀 정보로 보이는 내용은 거부하고 전체 대화는
38
+ 저장하지 않습니다. MCP 호출은 클라이언트와 모델의 판단에 달려 있습니다.
39
+ [보안과 신뢰 (영문)](docs/security-and-trust.md).
package/README.md CHANGED
@@ -1,214 +1,39 @@
1
1
  # Kiokuko (記憶庫)
2
2
 
3
- Version 1.0 requires a new database and removes the previous orchestration. See [breaking changes and setup cleanup](docs/breaking-changes-1.0.md).
4
-
5
3
  English | [日本語](README.ja.md) | [简体中文](README.zh-CN.md) | [한국어](README.ko.md)
6
4
 
7
- **Connect through MCP, learn from interaction, and recall useful context.**
8
-
9
- Kiokuko is local external memory for AI agents, for coding work and ordinary
10
- conversation. Your client can save durable preferences, decisions, corrections,
11
- and useful results as untrusted SQLite records, then recall relevant context for
12
- the next interaction. You keep using your client normally through MCP.
13
-
14
- ## The core idea
15
-
16
- ```text
17
- request → MCP connection → retrieve relevant memory → do the work
18
- ↓
19
- save reusable knowledge
20
- ```
21
-
22
- Recall defaults to 16,000 Unicode body characters, with a separate bounded typed-relation envelope. Explicit budgets and item limits are preserved. See [context delivery](docs/context-delivery.md).
5
+ Local memory for AI agents. Save preferences, decisions, and corrections in
6
+ SQLite, then recall relevant context through MCP.
23
7
 
24
- Memory is separated into Project, Ecosystem, and Global scopes. Current source,
25
- configuration, and execution results take precedence over remembered context.
8
+ Works with **Codex, OpenCode, Claude Code, and Hermes Agent**.
9
+ [ChatGPT support is in preview](docs/setup-notes.md#chatgpt).
26
10
 
27
- ## Quick start
11
+ ## Install
28
12
 
29
- Node.js 24.16.0 or newer is required (Node.js 26.1.0 or newer is also supported).
13
+ Requires Node.js **24.16.0 or newer**.
30
14
 
31
15
  ```bash
32
- npm install --global kiokuko
16
+ npm i -g kiokuko
33
17
  kiokuko setup
34
18
  ```
35
19
 
36
- `setup` initializes the local database, detects supported clients, installs the
37
- bundled standard Skills, configures their MCP connection, and enables local semantic
38
- retrieval. The first run installs the embedding runtime and model. Restart a client that
39
- was already running after setup. Exact configuration rules and recovery procedures
40
- are in the [Getting started guide](docs/getting-started.md).
20
+ Restart your client, then use it normally. Setup configures MCP, bundled Skills,
21
+ and local semantic search. To skip embedding downloads, use
22
+ `kiokuko setup --no-embeddings`.
41
23
 
42
- To configure clients without installing the embedding runtime or model:
24
+ Upgrading from before 1.0 requires a new database.
25
+ [Migration and cleanup](docs/breaking-changes-1.0.md).
43
26
 
44
- ```bash
45
- kiokuko setup --no-embeddings
46
- ```
47
-
48
- This skips embedding setup and preserves any existing embedding settings.
27
+ ## Docs
49
28
 
50
29
  <a id="setup-messages"></a>
51
30
 
52
- ### npm notices and setup errors
53
-
54
- `install scripts not yet covered by allowScripts` means npm has no recorded
55
- approval for those dependency scripts. `esbuild` is a build tool; `fsevents`
56
- supports macOS file watching. The notice alone does not mean setup failed.
57
-
58
- Run this in the package directory that produced the notice:
59
-
60
- ```bash
61
- npm install-scripts ls
62
- ```
63
-
64
- If it lists `esbuild` and `fsevents`, and you have reviewed and want to allow their
65
- scripts, record approval with:
66
-
67
- ```bash
68
- npm install-scripts approve esbuild fsevents
69
- ```
70
-
71
- Approval updates that directory's `package.json`. For a global macOS Kiokuko
72
- install, use the installed Kiokuko directory shown in the error; running these
73
- commands in another project reviews and changes that project's policy.
74
- See [npm's script approval guide](https://docs.npmjs.com/cli/v11/commands/npm-install-scripts/).
75
-
76
- If setup ends with `Local semantic retrieval dependencies remain unavailable`
77
- and `Cannot find package ... @huggingface/hub/index.js`, the embedding runtime
78
- could not load and semantic setup is incomplete. Script approval is not a
79
- confirmed fix for this import error. Report the full error and the output of
80
- `kiokuko --version`, `node --version`, and `npm --version` when requesting help.
81
-
82
- ### Saved runtime for Codex
83
-
84
- To keep Codex MCP and lifecycle hooks on one version while npm replaces its installation, prepare a separate runtime in a private application-data directory. Finish current work and stop Codex before changing its configuration:
85
-
86
- ```bash
87
- kiokuko runtime-prepare --runtime-root "$HOME/Library/Application Support/Kiokuko/runtimes" --json
88
- kiokuko setup --clients codex --no-embeddings --no-standard-skills --runtime-manifest /absolute/path/to/runtime/manifest.json --client-stopped
89
- kiokuko runtime-diagnose --manifest /absolute/path/to/runtime/manifest.json --json
90
- ```
91
-
92
- On Linux, use `${XDG_DATA_HOME:-$HOME/.local/share}/kiokuko/runtimes` as the runtime root. Replace the manifest example with the `manifestPath` printed by the first command. If the current Node executable depends on libraries outside its own binary, preparation fails; supply a standalone Node binary with `--node /absolute/path/to/node`. Preparation never changes client settings. The setup command verifies the saved files, updates the managed MCP and all lifecycle hooks together, and restores previous configuration files if the update fails. Restart Codex only when the diagnostic reports `readyForRestart: true`. Existing custom MCP commands are preserved and require separate migration.
93
-
94
- An npm update alone does not switch the saved version. To upgrade, stop Codex after current work, prepare the new version, run the setup command with its new manifest, then restart. Keep the old saved directory for recovery; old versions are not deleted automatically. If the new version migrated the memory database, check database compatibility before returning to an older version. Allow several hundred megabytes per saved version, depending on Node and installed optional dependencies; check the actual directory size before keeping multiple versions.
95
-
96
- ### Repository instruction files
97
-
98
- `kiokuko use` keeps a short, stable pointer in the repository's `AGENTS.md`
99
- (or the configured agent file). Kiokuko's generated instructions live in
100
- `.kiokuko/AGENTS.md`, relative to the repository root. Template upgrades and
101
- repository identity changes update that generated file without rewriting the
102
- root pointer. Keep custom instructions outside Kiokuko's managed markers.
103
- Existing versioned Kiokuko blocks migrate to the pointer on the next use/setup
104
- refresh; user text and other products' sections remain unchanged. A missing
105
- root instruction file is not recreated by routine setup; use `kiokuko doctor`
106
- to review a repair. Missing generated instructions can be restored by use/setup
107
- or an approved doctor repair. Uninstall removes only Kiokuko's managed regions
108
- from both files, preserving surrounding content.
109
-
110
- ## Uninstall
111
-
112
- Stop clients using Kiokuko and any `kiokuko serve` process first.
113
-
114
- ```bash
115
- kiokuko uninstall --dry-run
116
- kiokuko uninstall
117
- # After selecting all agents and completing cleanup, run the printed command:
118
- npm uninstall --global kiokuko
119
- ```
120
-
121
- Use Up/Down to move, Space to toggle, Enter to submit, and Esc to cancel. All choices start unchecked.
122
- Only selected agents' managed settings and Skills are removed. **Selecting all four also deletes shared memory, embedding models, and managed project bindings**, then prints the npm removal command. Partial selection retains shared data and the npm package. User content is preserved.
123
- For scripts, use `kiokuko uninstall --clients opencode,claude` or `kiokuko uninstall --all` for complete cleanup.
124
- Use the same environment overrides as setup for custom locations. See [cleanup scope and failures](docs/cli-contract.md#uninstall).
125
-
126
- ## Main features
127
-
128
- - **Interaction memory**: learns durable preferences, decisions, and corrections from ordinary conversation as untrusted candidates. [How it works](docs/interaction-memory.md).
129
- - **RAG memory**: lexical retrieval plus local semantic retrieval configured by `setup`.
130
- - **Akinator**: clarifies vague requests before work begins.
131
- - **Local Web UI**: review and curate saved memories.
132
- - **Reference-only Skills**: discovered external Skills are verified and never executed automatically.
133
-
134
- `kiokuko embeddings setup` remains a compatibility entrypoint for `kiokuko setup`.
135
-
136
- Managed MCP blocks are updated and registered-project instructions are refreshed.
137
- An unmanaged identity is replaced only after interactive confirmation; non-interactive
138
- and `--dry-run --json` invocations fail closed without changing it. See the
139
- [semantic retrieval guide](docs/semantic-retrieval.md) for runtime, offline, and
140
- fallback behavior.
141
-
142
- ## Supported clients
143
-
144
- - Codex
145
- - OpenCode
146
- - Claude Code
147
- - Hermes Agent
148
-
149
- Client-specific setup, Web UI, and restart instructions are in
150
- [Getting started](docs/getting-started.md). The [documentation index](docs/README.md)
151
- links to conceptual and operational guides.
152
-
153
- Record sessions with [AgenticReplay](docs/agenticreplay.md) by wrapping the client
154
- using Kiokuko. AgenticReplay is optional and installed separately.
155
-
156
- ## Use with ChatGPT (preview)
157
-
158
- Connect a personal plugin in Developer mode to save and recall memory. No store-distributed plugin is available.
159
-
160
- 1. **Prepare Kiokuko.** Use a version whose `kiokuko mcp --help` lists `--profile` and `--access`; otherwise [install from source](docs/chatgpt.md). Run `kiokuko init` if you do not have a database.
161
- 2. **Install the Tunnel client.** On macOS, use the [official Homebrew instructions](https://github.com/openai/tunnel-client#install-with-homebrew):
162
-
163
- ```bash
164
- brew install openai/tools/tunnel-client
165
- tunnel-client --version
166
- ```
167
-
168
- For other operating systems, see the [official releases](https://github.com/openai/tunnel-client/releases/latest). In [Tunnel settings](https://platform.openai.com/settings/organization/tunnels), obtain a Tunnel ID associated with your ChatGPT workspace and a [runtime API key](https://platform.openai.com/settings/organization/api-keys) with Tunnels Read + Use permission.
169
-
170
- 3. **Start the connection on your computer.** Replace `<tunnel_id>` and `<runtime_api_key>` with your values.
171
-
172
- ```bash
173
- export CONTROL_PLANE_API_KEY="<runtime_api_key>"
174
- tunnel-client init \
175
- --sample sample_mcp_stdio_local \
176
- --profile kiokuko-chatgpt \
177
- --tunnel-id "<tunnel_id>" \
178
- --mcp-command "kiokuko mcp --profile chatgpt-memory --access read-write"
179
- tunnel-client doctor --profile kiokuko-chatgpt --explain
180
- kiokuko chatgpt run --profile kiokuko-chatgpt
181
- ```
182
-
183
- Keep it running while using the connection. In a new terminal, set the API key again and execute the final `run` command.
184
-
185
- 4. **Register in ChatGPT.** Enable **Settings → Security and login → Developer mode**. Under **Plugins → +**, name it `Kiokuko`, describe it as “Save and recall memory”, and choose **Connection → Tunnel** with the same ID. Select Kiokuko from the tools menu in a new conversation. [Official UI instructions](https://developers.openai.com/plugins/deploy/connect-chatgpt)
186
-
187
- Try: “Save this information in Kiokuko” or “Search Kiokuko for memories about [topic].” Review and approve write requests when prompted.
188
-
189
- For search only, change `read-write` to `read` in the launch command. This does not change ChatGPT's built-in memory storage. **Live ChatGPT connection testing is pending.** [Troubleshooting](docs/chatgpt.md)
190
-
191
- ## Safety and limitations
192
-
193
- Kiokuko does not store full conversations and rejects content that resembles secrets
194
- such as passwords, API keys, tokens, or private keys. Saved memories are advisory;
195
- verify them against the current repository and runtime.
196
-
197
- MCP use is client- and model-mediated. There is **no guarantee that Kiokuko is called
198
- on every turn**. If a client cannot initialize the required MCP connection, a client
199
- may stop rather than silently continue without policy. Trust boundaries and public
200
- error behavior are documented in [Security and trust](docs/security-and-trust.md).
201
-
202
- ## More detail
203
-
204
- - [Documentation index](docs/README.md)
205
31
  - [Getting started](docs/getting-started.md)
206
- - [Concepts](docs/concepts.md)
207
- - [Semantic retrieval](docs/semantic-retrieval.md)
208
- - [Akinator profile memory](docs/akinator-memory.md)
209
- - [Security and trust](docs/security-and-trust.md)
210
- - [CLI contract](docs/cli-contract.md)
211
-
212
- Implementation-focused references remain in [architecture](docs/architecture.md),
213
- [database](docs/database.md), [execution ledger](docs/execution-ledger.md), and
214
- [client compatibility](docs/client-compatibility.md).
32
+ - [Setup, troubleshooting, and uninstall](docs/setup-notes.md)
33
+ - [Memory and search](docs/concepts.md)
34
+ - [History and code evidence](docs/history-evidence.md)
35
+ - [All documentation](docs/README.md)
36
+
37
+ Saved memories can be wrong. Kiokuko rejects secret-like content and does not
38
+ store full conversations. MCP calls depend on your client and model.
39
+ [Security and trust](docs/security-and-trust.md).