OpenLore

OpenLore に Markdown ファイルのフォルダーを指定すれば、Claude Code、Codex、Cursor、CI ジョブのいずれを使っていても、チームのすべてのエージェントが同じファイルを読み取ります。エージェントは cat、grep、find など、使い慣れたツールを利用します。誰が何を閲覧・変更できるかは、自分で決められます。

_{ワンクリックでホスト型サーバーを利用できます。OpenLore を Render にデプロイするをご覧ください。}

クイックスタート

インストールして、フォルダーを提供します。

brew install --cask aakarim/tap/lore
openlore ./docs

SSH はポート 2222 で動作します。ウェブビューと MCP はポート 8080 を共有します。./docs の内容は / に表示されます。

エージェントを接続します。

# Claude Code
claude mcp add --transport http openlore http://localhost:8080/mcp

# Codex
codex mcp add openlore --url http://localhost:8080/mcp

# Anything with a shell
ssh -p 2222 localhost "grep -r 'retry' /"

いつ使うかをエージェントに伝えます。

ssh -p 2222 localhost agents >> AGENTS.md

または、セットアップ全体をエージェントに任せます。

ssh openlore.sh teach | claude

Homebrew を利用していない場合は、Linux と Windows 向けのクイックスタートをご覧ください。

Markdown をリポジトリに置いておくだけではいけないのですか？

1 つのリポジトリで 1 つのエージェントを使うなら、それで十分です。

複数のエージェント、リポジトリ、または人が同じ知識を必要とし、誰が何を読めるか、書き込めるか、公開できるかを指定する必要がある場合に OpenLore が役立ちます。ファイルを一度更新するだけで、すべてのエージェントが次に読み込むときに新しいバージョンを確認できます。

ベクトルデータベース、取り込みパイプライン、SDK は不要です。知識は通常の Markdown のまま保たれます。

ガイド

• OpenLore とは
• Claude Code
• Codex
• Cursor
• OpenCode
• Meta Muse
• OpenAI dots
• Grok Bot
• Claude Duet
• LangChain
• SSH 経由であらゆるエージェントを使う
• エージェントに受信箱へ公開させる
• Render にデプロイする
• 分析結果をもとにナレッジリポジトリを整理する
• OpenLore 上に LLM ウィキを構築する
• すべてのエージェントでコーディングスタイルガイドを共有する
• すべてのドキュメント

機能

• エージェントネイティブな検索 — エージェントは、独自の検索 API を新たに学ぶ代わりに、すでに理解しているシェルツールと組み合わせパターンを使います。
• 1 つのナレッジサーフェスで複数のトランスポートに対応 — 同じ仮想ファイルシステムを SSH、SFTP/SSHFS（VS Code からの直接閲覧・編集を含む）、MCP、人間に使いやすい Web ビューで提供します。
• 最新かつガバナンスの効いたナレッジ — コンテンツを読み取り専用にする、対象を限定した公開を許可する、またはドキュメントセットごとに完全な書き込みを有効にできます。書き込みはアトミックに行われ、競合に対応し、確定前に検証されます。
• アイデンティティに応じたビュー — ロールベースの ro、publish、rw の権限、パスエイリアス、プライベートホームディレクトリにより、各ユーザーやエージェントに必要なドキュメントセットだけを提供します。
• 設計上の安全性 — シェルは実際のオペレーティングシステムのシェルではなく、メモリ内で動作する Go インタープリターです。通常のセッションでは、シェルエスケープ、任意のプロセス実行、暗黙的なネットワークアクセスはありません。
• ポータブルなナレッジバンドル — ドキュメントを自己完結型のバイナリに埋め込んだり、GitHub Action でクロスプラットフォームのバンドルをビルドしたり、デスクトップ MCP 拡張機能としてパッケージ化したりできます。
• 新しいクエリ言語を使わない構造化ナレッジ — lore meta でフロントマターを NDJSON として調べ、jq でクエリを実行し、Google の オープンナレッジ形式（OKF） バンドルと Agent Skills を書き込み経路の近くで検証できます。
• 拡張可能なポリシーと処理 — プラグインで検証、権限付与、読み取り／書き込みミドルウェア、メタデータ、コミット後の処理を追加しながら、同じファイルシステムインターフェースを維持できます。

ユースケース

• 継続学習リポジトリ - セッションと学習内容を 1 つの共有サーバーに保存します。最適化できるようメトリクスを追加できます。ユーザー間の分離を維持しながら、エージェント同士で学習内容を共有できます。
• チーム成果物リポジトリ - 作成した Markdown、HTML、JSON、Excel などのドキュメントを、アクセス制御を維持しながら共有します。Git よりも自然で、Confluence／Notion よりもエージェントネイティブです。
• コーディングエージェント向けドキュメント — 社内 API ドキュメント、運用手順書、製品のコンテキスト、アーキテクチャのメモを、使い慣れた検索可能なインターフェースで提供します。
• エージェントチームで共有する最新のメモリ — エージェントに個別または共有のドキュメントセットを提供し、セッションをまたいで調査結果を公開し、作業を引き継ぎ、長期的に利用できるコンテキストを蓄積できます。
• 公開ドキュメントサイト - 公開ドキュメントセットに任意のファイルを追加して公開アクセスを有効にすると、サイトを見つけたエージェントが閲覧できるようになります。既存のドキュメントを編集する必要なく、AEO/GEO を改善できます。
• スキルの共有 — Agent Skills を共有コレクションに公開し、認可されたすべてのエージェントが、ガバナンスの効いた同じ手順を見つけて利用できるようにします。
• エージェントプラグインリポジトリ — GitHub の Agent Plugins リポジトリをバージョン固定して、チームのエージェントに提供します。オープン標準でパッケージ化されたスキルは、自動的に最新の状態に保たれます。
• ガバナンスの効いたナレッジの投稿 — 投稿者には受信箱への公開を許可しながら、既存のドキュメントをメンテナー向けに保護し、誤った上書きを防ぎます。
• 成果物リポジトリ — カスタムの成果物ビューアーを作成したり、エージェントのマシンへのアクセス権を付与したりすることなく、ブラウザーや SSH 経由でレポート、ログ、スクリーンショット、生成ファイルを保存して公開できます。
• アイデンティティごとのワークスペース — 1 つのサーバーと認可モデルで、エージェントごとのプライベートホームと共有チームナレッジをマウントします。
• ポータブルな顧客・プロジェクトナレッジ — 関連ドキュメントを埋め込んだバージョン付き実行ファイルを配布するか、同じナレッジを MCPB デスクトップ拡張機能として配布します。
• 検証済みのナレッジカタログ — フロントマターとバンドルの規約を徹底し、メタデータを手軽に調べ、不正なナレッジが取り込まれる段階で阻止します。

仕組み

OpenLore は SSH トランスポートに Wish を使用しています。接続はすべて仮想ファイルシステム上で処理されます。

1. 認証 — キーなしで接続するか、SSH キー、証明書、パスキー、OAuth ログインをアイデンティティに解決します。
2. ビューを構成 — そのアイデンティティに許可されたドキュメントセットとパスのみをマウントします。
3. 探索 — ビューに対する純粋な Go 関数として実装されたシェルコマンドを実行するか、同等の MCP lore_bash ツールを使用します。
4. 安全にコントリビュート — 書き込みが有効な場合は、ファイル全体の変更を承認して検証してから、アトミックにコミットします。

OAuth クライアントは委任されたアイデンティティを使用するため、永続的な書き込み履歴では、adil による直接の作業と adil/[email protected] として実行された作業が区別されます。委任先が持てる権限は本人以上にはならず、ドキュメントセットや機能の拒否リストによってさらに制限できます。CIMD クライアントは、ベンダーがホストするメタデータと private_key_jwt を使用して認証することもできます。詳しくは、認証済み OAuth クライアントをご覧ください。

通常のシェルから bash、exec、curl、任意のホストプロセスを呼び出すことはできません。埋め込みドキュメントは常に読み取り専用です。明示的に信頼されたアイデンティティには、spawn 機能を通じて、対象範囲を限定した非同期処理を許可できます。

ガバナンスされた書き込み

OpenLore はデフォルトで読み取り専用です。書き込み可能なデプロイでは、リダイレクト、追記、tee、patch、sed -i、ファイル移動、公開、信頼された外部ジョブに対して、ポリシーで制御された単一の書き込み経路を使用します。

echo "# Research" | publish /backend/findings.md
cat change.diff | patch /backend/api.md
sed -i 's/old/new/g' /backend/runbook.md

書き込みは、オブジェクト全体をアトミックに置き換えて行います。比較とスワップによる保護機能はデフォルトで古い編集を拒否し、ドキュメントセットの許可設定は対象を制限します。また、プラグインは書き込みのコミット前に検証したり、保留にしたりできます。

ユーザー向けのセットアップについては書き込みと公開を、実装モデルについては書き込みシステムの内部をご覧ください。

インストール

Homebrew、Linux、Windows 向けのリリースと、ダッシュボードが含まれるインストール方法については、クイックスタートをご覧ください。OpenLore を自分でビルドする方法については、ソースからのビルドをご覧ください。

バイナリにドキュメントを埋め込む

ドキュメントを assets/lore/ に配置してビルドします。生成されたバイナリにはドキュメントが含まれ、ディレクトリ引数なしで実行すると /docs で読み取り専用として提供されます。

make dashboard-build   # optional: include the web UI
go build -o my-docs ./cmd/openlore

GitHub Action を使ってビルドする

ドキュメントを埋め込んだ、クロスプラットフォーム対応のバイナリを生成します。

- uses: aakarim/openlore@v1
  with:
    docs-dir: ./docs
    config: ./openlore.yml

VS Code での直接編集、MCP stdio、MCPB デスクトップパッケージ、SSHFS、Go ライブラリの使用方法については、OpenLore の利用方法をご覧ください。

カスタマイズしたデプロイメントを作成する

同梱の setup スキルを使用して、<team>-lore を作成します。これは、openlore.yml、公式の OpenLore リリースに固定した薄い Containerfile、およびデプロイ用アーティファクトを含む、顧客所有の小規模なリポジトリです。デプロイ前に、動作するローカルサーバーをビルドし、HTTP、MCP、認証済み SSH、書き込み、永続性を検証します。

ssh openlore.sh setup | amp

生成されるリポジトリでは、初期の lore.json ポリシーと SSH から参照できるファイルは、Git の追跡対象外である .local/ に保存されます。最初のデプロイ時には、この状態を基に空の永続ボリュームを初期化します。ルートの openlore.yml は引き続き Git／IaC の正本であり、イメージには含めず、/var/lib/openlore/config/openlore.yml に別途デプロイします。以降、サーバー上で行われた lore.json およびファイルシステムの変更が正本となり、イメージの更新によって上書きされることはありません。

ライフサイクル全体をサポートする追加のコマンドは次のとおりです。

• onboarding は、初期の ID、ロール、ホーム、フォルダーをローカルに追加します。
• deploy は、Fly.io、Railway、AWS、Google Cloud、Azure、DigitalOcean、またはカスタムデプロイメントを選択し、共通の永続化／ネットワーク契約を検証します。
• upgrade は、固定されたベースイメージのバージョン変更のみを準備し、既存の CD でデプロイできるようにします。

プロバイダーへのデプロイには、HTTPS／MCP、認証済み OpenLore SSH、管理者用シェルアクセス、および永続的な /var/lib/openlore ボリュームが必要です。プロバイダーが対応している場合、デプロイ時にパブリックポート 22 から OpenLore のポート 2222 への転送を設定します。対応していない場合は、割り当てられたポートを報告し、外部 TCP 転送システムの利用を推奨します。

公開コンテナーに含まれるのは OpenLore のみです。オンボーディングポリシーやサーバー設定は意図的に含めていません。サービスの起動前に、デプロイメントで openlore.yml と lore.json を永続設定ディレクトリに配置し、次を実行する必要があります。

./out --config /var/lib/openlore/config/openlore.yml

この方法では、設定を個別にデプロイできます。シンプルなデプロイメントでは openlore.yml をボリュームにコピーし、Kubernetes では同じファイルを ConfigMap から投影できます。Fly.io、Railway、AWS、Google Cloud、Azure、DigitalOcean、またはカスタムインフラストラクチャには、deploy スキルを使用してください。リポジトリに含まれる Railpack ファイルと Fly ファイルは、イメージ、永続ボリューム、ポートの接続を設定します。プロセス起動時に設定を初期化したり変更したりすることはありません。

カスタマイズしたリポジトリを作成せずに、手軽にホスト型サーバーを利用するには、Render にデプロイボタンを使用してください。Railpack ファイルや Fly ファイルとは異なり、Render の起動スクリプトは初回起動時に、空のディスクへ初期設定の openlore.yml と lore.json を書き込みます。Render が提供するのは HTTPS、MCP、ウェブビューのみです。OpenLore SSH 用のパブリック TCP イングレスはありません。

Railway は、SSH TCP プロキシにパブリックホスト名とポートを割り当てます。標準の SSH ポート 22 を使用するには、外部の生 TCP ロードバランサーが必要です。Fly.io では、専用アドレスを使用して、パブリックポート 22 から OpenLore の内部ポート 2222 にマッピングできます。生の SSH にはホスト名や SNI によるルーティングがないため、1 つのリスナーでポート 22 の複数ドメインへ振り分けることはできません。

コンテナーのワークフローでは、main から latest を公開します。リリース時には、VERSION、vVERSION、メジャー、マイナーの各イメージタグも公開します。

ドキュメント

同じページが同じグループに分類され、openlore.sh/docs に公開されています。

はじめに

ページ	内容
OpenLore とは	提供、接続、範囲設定、ガバナンス、監視を 1 ページで解説
変更履歴	現在のバージョン、リリースノート、互換性に関する注意事項、バージョン別ドキュメント

はじめに

ページ	内容
クイックスタート	OpenLore をインストールし、フォルダーを提供して、エージェントを接続します
Claude Code	MCP 経由で Claude Code を接続し、参照できる範囲を設定します
Codex	MCP 経由で Codex を接続します
Cursor	MCP 経由で Cursor を接続します
OpenCode	MCP 経由で OpenCode を接続します
Meta Muse	MCP 経由で Meta Muse を接続します
OpenAI dots	MCP 経由で OpenAI dots を接続します
Grok Bot	MCP 経由で Grok Bot を接続します
Claude Duet	MCP 経由で Claude Duet を接続します
LangChain	MCP 経由で LangChain エージェントを接続し、ID を付与します
SSH 経由で任意のエージェントを接続	コーディングエージェントまたは CI ジョブを SSH 経由で接続し、ID を付与します

概念

OpenLore の仕組み：ドックセット、トランスポート、ID、書き込み、ルール、監視。

ページ	内容
ドックセット	ドックセットとは何か、アクセスがドックセットを中心に構成される理由、ネスト、権限付与、エイリアス、フェイルクローズ検証の仕組み
トランスポート	SSH、SFTP、MCP、JSON API、ウェブが単一のファイルシステム、MCP ツール、コマンド結果、セッション、指示コマンドを共有する仕組み
認証	認証の方針、SSH キー、証明書、パスキー、OAuth トークン、受信トレイの認証情報が ID、ロール、ドックセット、エイリアス、ホーム、ワークロード ID フェデレーションにどのように解決されるか
書き込みと公開	書き込みモード、受信トレイ、競合処理、成功した書き込みで確認されることとされないこと、ジョブ
フォルダールール	.lore/config.yaml と lore.json のルール、レイヤー構成、権限、拒否メッセージ、増加上限
プラグインと形式	プロバイダーインターフェース、Open Knowledge Format の検証、lore validate、lore meta、Agent Skills プラグイン
ダッシュボードとメトリクス	ダッシュボード認証、事実とアクティビティの違い、ファイルビューアー

手順

タスク別のガイド。

ページ	内容
OpenLore の利用方法	SSH、HTTP および stdio 経由の MCP、ウェブビュー、SSHFS、組み込みバイナリ、GitHub Action、MCPB、ライブラリの利用方法を設定します
サーバーを設定する	openlore.yml の作成、組み込み設定やフラグより優先される順序、HTTPS、アナリティクス、デバッグログ
本番環境チェックリスト	クラウドエージェントからアクセスできる共有サーバーに必要なもの：標準で HTTPS に対応したホスト、ボリューム上の固定イメージ、パブリックオリジン、/mcp のトークン、パスキー
エージェントから受信トレイに公開する	ほかの場所は編集させずに、エージェントからの投稿を受け入れます
エディターから閲覧・編集する	ローカルのプロジェクトミラーを使わずに VS Code と SFTP のエディターを直接設定します
headlong / shellm を実行する	headlong の shellm エンジンから SSH 経由で OpenLore を利用します。ハウスキーピングスキルも含みます
ソースからビルドする	ウェブ UI とバイナリを自分でビルドするか、ウェブ UI なしでビルドします
OpenLore を Render にデプロイする	ワンクリックの Render デプロイ、初回のパスキーサインイン、アップグレード、カスタムドメイン

リファレンス

参照資料：コマンド、キー、エンドポイント、インターフェース、内部仕様。

ページ	内容
コマンドリファレンス	シェル、イントロスペクション、公開、構文、CLI コマンド、フラグの完全なリファレンス
openlore.yml リファレンス	openlore.yml で使用できるすべてのキーの自動生成リファレンス
ルール標準ライブラリ	コンパイル時に組み込まれるルールメンバーとそのパラメーターの自動生成リファレンス
HTTP inbox API	ベアラー認証情報または HMAC 認証情報を使う POST /inbox/{docset} と、トークンエンドポイント
OAuth クライアント	CIMD クライアント ID、private_key_jwt、mTLS による裏付け、署名鍵のローテーション
書き込みシステムの内部仕様	ファイルシステムのレイヤー構造、書き込みシーム、アドミッションミドルウェア、非同期ジョブ
ダッシュボードのビルド	フロントエンドのビルドとバックエンドのみの Go ビルド
セキュリティ評価	脅威モデルとセキュリティ特性

セキュリティ

• コマンドは os/exec を通さず、純粋な Go インタープリターで実行されます。
• 仮想ファイルシステムはパスをクリーンアップし、docset の境界を適用します。
• 許可されたファイルパターンと無視対象ディレクトリにより、ビューに秘密情報が含まれないようにします。
• RBAC によって、読み取り、公開、書き込み、承認、信頼された機能が制御されます。
• Web エンドポイントは TLS 経由で SSH ホスト鍵を公開できるため、初回使用時の盲目的な信頼を回避できます。SSH ユーザー証明書とホスト証明書にも対応しています。

セキュリティ評価の全容については、SECURITY.md を参照してください。

ライセンス

Apache License 2.0 — Copyright © 2026 Adil Karim

OpenLore には、サードパーティのオープンソースコンポーネントが含まれています。ライセンスと必要な通知は assets/legal/THIRD_PARTY_NOTICES.md に記載されており、 ライセンス全文は assets/legal/licenses/ にあります。これらはバイナリに組み込まれ、実行中のサービスから /legal で配信されます。