OpenWiki: コードベースのエージェントドキュメントを記述および維持するCLI
OpenWiki: CLI that writes and maintains agent documentation for your codebase (github.com)
要約
OpenWikiは、エージェントのために特別に構築された、コードベースのドキュメントを記述および維持するCLIツールです。GitHubアクションと連携してドキュメントを最新の状態に保ち、様々なLLMプロバイダーとモデルをサポートしています。このツールは、コードベースのコンテキストを検索する際に、コーディングエージェントが参照できるように設計されています。
全文翻訳
フォルダとファイル
あなたのコード、エージェント、そしてあなた自身のための生きたウィキ。
[画像: npm version] [画像: downloads] [画像: Node] [画像: License: MIT] [画像: Built with Deep Agents]
[画像: langchain-ai%2Fopenwiki | Trendshift]
OpenWikiは、あなたのコードベースと知識ソースを、あなたが所有するリンク付きMarkdownウィキに変換します。コーディングエージェントはこれを使用してリポジトリを理解し、質問に答え、関連プロジェクト間のコンテキストを見つけることができます。あなたは同じページを読むことも、インタラクティブなグラフとして探索することもできます。
リポジトリウィキの場合、OpenWikiはソース証拠に事実を追跡するため、更新は変更されたものに集中できます。コーディングエージェント内で開始するか、スタンドアロンCLIを使用してリポジトリドキュメント、個人的な知識、およびスケジュールされた更新を行います。
開始方法 · ウィキの検索とリンク · 探索 · スタンドアロンCLI · コマンドリファレンス
🎉 最新情報
- リンクされたウィキワークスペース:
openwiki linkを使用して関連リポジトリをグループ化し、それらのウィキ全体を検索し、MCPを通じて関連セクションを読み取ります。仕組みを見る → - より多くのコーディングエージェント統合: Oh My Pi、Antigravity、IBM Bob / Bob Shell、Kiro が Codex、Claude Code、OpenCode、GitHub Copilot、Cursor に加わりました。エージェントを接続する →
- 並列ページワーカー: ネイティブCLI実行で複数のページを同時にドキュメント化し、ページごとに進捗を保存し、プロバイダーのレート制限に適応できるようになりました。並列処理を設定する →
- 再開可能な更新と根拠のある主張(Claims): 完了したページは中断を乗り越え、バージョン管理されたソース証拠は注意が必要な事実を特定します。アーキテクチャを探索する →
ポータブルなOKF v0.2出力と公開可能なビジュアライザーも利用可能です。
クイックスタート
最も簡単な開始方法は、既に使用しているコーディングエージェント内で行うことです。OpenWikiは、そのエージェントの認証済みモデルセッションとリポジトリツールを使用するため、個別のモデルプロバイダーを設定する必要はありません。
1. OpenWikiのインストール
Node.js 22.22.0以降が必要です。
npm install -g openwiki
Piを使用している場合は、ステップ2でPiを通じてパッケージをインストールしてください。個別のグローバルOpenWikiインストールは不要です。
2. コーディングエージェントの接続
お使いのエージェントの統合を選択してください:
| コーディングエージェント | インストール |
|---|---|
| Codex | openwiki integrations install codex |
| Claude Code | openwiki integrations install claude |
| OpenCode | openwiki integrations install opencode |
| Cursor | openwiki integrations install cursor |
| IBM Bob / Bob Shell | openwiki integrations install bob |
| Kiro | openwiki integrations install kiro |
| Oh My Pi | openwiki integrations install omp |
| Antigravity | openwiki integrations install antigravity |
| GitHub Copilot CLI | openwiki integrations install copilot |
| Pi | pi install npm:openwiki |
3. ウィキの作成
コーディングエージェントを再起動し、リポジトリを開いて、次のように依頼してください:
Initialize this repository's OpenWiki from the current source and tests.
エージェントがリポジトリを調査し、openwiki/にリンクされたウィキを作成します。OpenWikiはソース証拠を追跡し、各ページが完了すると進捗を保存します。
[画像: Codex initializes an OpenWiki for a repository.]
ウィキの準備ができたら、質問する、関連リポジトリをリンクする、または視覚的に探索することができます。
インストールスコープ、ホスト固有のパス、および削除
すべての統合はデフォルトでユーザーレベルにインストールされるため、1回のインストールでどのGitリポジトリからでも機能します。インストールステータスを確認するには openwiki integrations list を使用するか、統合を安全に削除するには openwiki integrations uninstall <host> を使用します。リポジトリスコープの状態に対して list、install、または uninstall に --project [path] を追加してください。プロジェクトパスはGitリポジトリのルートに解決されます。
ホスト固有の場所と注意点:
- OpenCodeは
~/.config/opencodeを使用します。 - IBM Bob / Bob Shellは、ユーザーレベルでは
~/.agents/skillsおよび~/.bob/settings/mcp.jsonを、プロジェクトレベルでは.agents/skillsおよび.bob/mcp.jsonを使用します。 - Kiroは
~/.kiro/skillsおよび~/.kiro/settings/mcp.jsonを使用します。 - Oh My Piは、ユーザーレベル(デフォルトプロファイル)で
~/.omp/agentを使用します。名前付きプロファイルまたは移動されたPI_CODING_AGENT_DIRには--projectを使用します。 - Antigravityは
~/.gemini/antigravity-cli/skillsおよび~/.gemini/config/mcp_config.jsonを使用します。 - GitHub Copilot CLIは、ユーザーレベルでは
~/.copilot/skillsおよび~/.copilot/mcp-config.jsonを、プロジェクトレベルでは.github/skillsおよび.github/mcp.jsonを使用します。 - PiはOh My Piとは異なります。PiはnpmパッケージからOpenWikiのスキルと6つのライフサイクルツールをロードします。プロジェクトローカルインストールには
pi install --local npm:openwikiを使用します。その拡張機能はパッケージ自身のCLIをNode経由で起動するため、openwikiをPATHに置く必要はありません。Piはopenwiki integrations installのターゲットではありません。
Windowsでは、Node.jsパッケージマネージャー(npm install -g openwikiまたはpnpm add -g openwiki)でインストールします。bunでインストールすると、better-sqlite3ネイティブ依存関係のコンパイルにフォールバックする可能性があり、これにはVisual Studio Build ToolsとC++デスクトップ開発ワークロードが必要です。
コーディングエージェント統合がサポートするもの
現在のホスト駆動型実行は、リポジトリコードウィキのみをサポートし、パーソナルブレインはサポートしません。リポジトリソースとテストを使用します。LangSmithを含むコネクターソースからのコンテキストは、まだサポートされていません。
コーディングエージェントはリポジトリを調査し、ウィキを計画し、ネイティブリポジトリツールを使用して各割り当てられたページを順次書き込みます。OpenWikiは永続的なキュー、Claimの検証と永続化、ソースドリフト処理、およびClaim、インデックス、出所、セットアップファイル、メタデータの決定論的な完了を管理します。
MCP生成ライフサイクルはopenwiki_begin → openwiki_submit_plan → openwiki_next_page → openwiki_submit_page → … → openwiki_finishであり、オプションでオンデマンドのopenwiki_inspect_page_claimsがあります。ホストは各ページに対して疎なClaimの決定のみを送信します。OpenWikiは影響を受けない現在のClaimを保持し、明示的な確認、修正、追加、または撤回を適用し、最終状態が永続化されるまで完了を拒否します。
他のコーディングエージェントを追加する貢献者は、コーディングエージェント統合の追加に従ってください。
ウィキの検索
エージェントにウィキ内の質問を検索するように依頼します:
Search this repository's OpenWiki for how retry handling works, then read the
relevant sections.
openwiki_searchはコンパクトでランク付けされた結果を見つけ、openwiki_readはエージェントが選択した完全なセクションを取得します。エージェントは、具体的な質問のために検索を使用し、関連セクションを読み、根拠が得られたら停止するように誘導されます。これはオプションのコンテキストであり、すべてのタスクの開始時にルーチンで行われるステップではありません。
これらのツールはローカルで読み取り専用であり、モデルフリーです。生成実行を開始したり、独自のモデル呼び出しを行ったりしません。リポジトリがリンクされている場合、openwiki_list_workspacesとopenwiki_list_wikisは検出を提供します。
ウィキワークスペースの作成
サービスは、コントロールプレーン、データプレーン、インフラストラクチャなど、複数のリポジトリにまたがることがよくあります。openwiki linkを使用して、既存のウィキを名前付きワークスペースにグループ化します。エージェントは、サービス全体を検索し、いずれかのメンバーウィキから関連セクションを読むことができます。
~/devのようなディレクトリからワークスペースマネージャーを開始します:
cd ~/dev
openwiki link
Paymentsのようなワークスペースを作成し、含めるリポジトリを選択します。それらは独自のウィキを保持し、複数のワークスペースに属することができ、親ディレクトリを共有する必要はありません。
リポジトリの検索と検索ワークスペースの選択
ファインダーは、編集可能なパスの下にあるGitリポジトリを、起動ディレクトリからストリーミングします。パスを拡張して結果を絞り込むか、Backspaceキーを押して~に戻り、最も近い既存のディレクトリから再スキャンします。各リポジトリはパスごとに1回表示されます。○は利用可能なOpenWikiリポジトリを示し、選択されると●になります。OpenWikiドキュメントがないリポジトリは薄暗く表示されます。選択は、変化する結果の上にピン留めされ、ファインダーにも残ります。
OpenWikiソースチェックアウトから、pnpm run dev link ~/devでマネージャーを実行します。レジストリは~/.openwiki(またはOPENWIKI_CONFIG_DIR)の下にプライベートに保存されます。
検索は次のようにスコープを選択します:
- どのワークスペースにも属さないウィキは、それ自体を検索します。
- 1つのワークスペースに属するウィキは、そのワークスペースを自動的に検索します。
- 複数のワークスペースに属するウィキは、アクティブなワークスペースを使用します。
- 複数のワークスペースに属していてアクティブな選択がない場合、検索は
workspace_requiredを返し、エージェントがどのワークスペースを使用するか尋ねます。
リポジトリ内のどこからでも、リポジトリのアクティブな永続ワークスペースを設定、検査、またはクリアできます:
openwiki workspace use payments
openwiki workspace current
openwiki workspace clear
エージェントは、現在のウィキまたは他のウィキのメンバーシップを検出するためにopenwiki_list_workspacesを呼び出すことができ、ワークスペースを検査するためにopenwiki_list_wikisを呼び出すことができます。ワークスペースの検索結果は、供給元のwikiを識別します。そのIDを結果のページとセクションアンカーとともにopenwiki_readに渡します。
ウィキの探索
任意のウィキを、ライブのサイドバイサイドMarkdownリーダーを備えたインタラクティブなノードグラフに変換します:
openwiki visualize
[画像: The OpenWiki visualizer: an interactive node graph beside a live Markdown reader.]
グラフはウィキの編集に合わせて更新されます。
ローカルサーバーオプションと静的ビジュアライザーの公開
これは./openwikiをローカルループバックアドレス(127.0.0.1、ネットワークに公開されない)で提供し、ブラウザをグラフに開きます。サーバー実行中は、ウィキファイルへの編集は自動的に検出されます。別のディレクトリを視覚化するにはパスを渡し、ポートを選択するには--port <port>(競合時にインクリメント、デフォルト4321)、ブラウザを開かないようにするには--no-openを渡します:
openwiki visualize openwiki --port 4400 --no-open
生成されたドキュメントの横にビジュアライザーを公開するには、サーバーを起動する代わりに静的ディレクトリをエクスポートします:
openwiki visualize openwiki --export docs/openwiki-visualizer
エクスポートにはindex.html、client.js、client-lib.js、styles.css、およびgraph.jsonが含まれます。クライアントは兄弟のグラフファイルを読み込み、ライブリロードを使用しないため、ディレクトリはGitHub Pages、MkDocs、またはその他の静的ホストでホストできます。--exportは--portまたは--no-openと組み合わせることはできません。
[!NOTE] ページは、ローカルおよび静的ビューアの両方でインターネット接続が必要です。そのため、グラフ、Markdown、およびダイアグラムライブラリをパブリックCDNからロードします。
ウィキを最新の状態に保つ
コードを変更した後、コーディングエージェントに次のように依頼してください:
Update this repository's OpenWiki for changes since its last successful run.
OpenWikiはリポジトリの変更と既存のClaimの背後にある証拠をチェックして、何が更新される必要があるかを決定します。クリーンな更新はモデル作業をスキップし、ウィキコンテンツを変更しません。
スケジュールされた更新
CIジョブをスケジュールして、ウィキが変更されたときにドキュメントPRを開くことで、自動的に最新の状態に保ちます:
- GitHub Actions:
openwiki-update.ymlを.github/workflows/openwiki-update.ymlにコピーします。 - GitHub Actions(自動マージ付き): 代わりに
openwiki-update-auto-merge.ymlをコピーし、以下のセットアップ手順に従います。 - GitLab CI:
openwiki-update.gitlab-ci.ymlを.gitlab-ci.ymlにコピーするか、パイプラインからインクルードします。 - Bitbucket Pipelines:
openwiki-update.bitbucket-pipelines.ymlをbitbucket-pipelines.ymlにコピーし、openwiki-updateパイプラインをスケジュールします。
OpenWiki PRの自動マージ
自動マージはOpenWikiランタイム機能ではなく、リポジトリインフラストラクチャです。GitHub Actionsの例はドキュメント専用のPRを作成し、OpenWikiが正常に完了した後にのみGitHubの自動マージを有効にします。必要なブランチチェックとレビューは、PRがいつマージされるかを引き続き制御します。失敗した実行は、PRに部分的なドキュメントを保持し、保留中の自動マージを明示的に無効にすることができます。
例を使用する前に:
- リポジトリのプルリクエスト設定で自動マージを許可するを有効にします。
- デフォルトブランチのブランチ保護またはルールセットを追加します。生成されたドキュメントをゲートするチェックを要求し、OpenWiki PRが人間のレビューを必要とするかどうかを決定します。
- 対象リポジトリへのアクセス権のみを持つ、きめ細かいパーソナルアクセストークンまたはGitHub Appトークンを作成し、Contents: read and writeおよびPull requests: read and writeの権限を付与します。これを
OPENWIKI_PR_TOKENActionsシークレットとして保存します。 - 例を
.github/workflows/openwiki-update.ymlにコピーし、ピン留めされたOpenWikiバージョンとプロバイダーを選択し、プロバイダーシークレットを追加します。
専用トークンは意図的なものです。デフォルトのGITHUB_TOKENで作成されたプルリクエストはほとんどのpull_requestワークフローを開始しないため、必要なPRチェックが実行されない可能性があります。組織ポリシーでは、パーソナルアクセストークンの代わりにGitHub Appトークンが必要になる場合があります。ワークフローのadd-pathsを生成されたドキュメントに制限し、すべてのactionとパッケージバージョンをピン留めし、実行可能ワークフローファイルへの変更を自動マージしないようにしてください。
OpenWikiを直接実行する
OpenWiki自身のDeep Agentsドキュメントエージェントを、スケジュールされた実行やパーソナルウィキにも使用できます。CLIのインストール後、リポジトリウィキを初期化します:
openwiki --init
最初の実行でプロバイダー、認証情報、モデルの選択をガイドし、openwiki/にドキュメントを書き込みます。OpenWikiは14のモデルプロバイダーをサポートしており、ホストされたモデルやローカルのOpenAI互換エンドポイントが含まれます。
リポジトリの変更と最後の正常な実行以降の変更、および стаale なClaimから既存のウィキを更新します:
openwiki --update
ウィキの再初期化と中断された実行の再開
openwiki --initを再度実行すると、既存の生成されたリポジトリウィキとClaimが新しいものに置き換えられますが、ユーザー作成のopenwiki/INSTRUCTIONS.mdの概要は保持されます。永続的なチェックアウトでは、OpenWikiはopenwiki/.run.jsonに進行中のリポジトリ生成を記録するため、中断後に同じコマンドを再実行すると、永続的なページキューが再開されます。新しい実行状態が永続化される前にセットアップが失敗した場合、エフェメラルCIランナーは新しく開始されます。新しい実行状態が永続化される前にセットアップが失敗した場合、以前のウィキが復元されます。
2つのモード
OpenWikiは2つのモードのいずれかで実行されます。ベアopenwiki、openwiki --init、およびopenwiki --updateはデフォルトでコードモードになります。パーソナルブレインの場合はpersonalの位置引数(または--mode personal)を追加します。
| モード | ドキュメント |
|---|---|
| コード(デフォルト) | 現在のリポジトリ |
| パーソナル | 接続されたソース |
デフォルトでは、CLIは実行後に開いたままになり、フォローアップメッセージを送信できます。-p / --printを追加すると、ワンショットで非対話的に実行され、最終出力が表示されて終了します。--initと--updateは対話型ターミナルで成功すると自動的に終了するため、同じコマンドがワンショットでも対話型でも機能します。
並列ページワーカー
ネイティブリポジトリのinitおよびupdate実行は、複数のページを同時にドキュメント化できます:
OPENWIKI_PAGE_CONCURRENCY=4 openwiki --update
並列処理はデフォルトで1であり、1から8までの値を受け入れます。2から4で開始し、プロバイダーのレート制限を確認してください。コーディングエージェント統合はホストのシーケンシャルページライフサイクルを使用します。この設定はネイティブCLIのワーカーを制御します。
ワーカーの順序、レート制限、およびリトライ
各ワーカーは正確に1つのページを所有し、完了したページは永続的な再開ユニットとして残ります。クイックスタートページは、ルーティング先のページにリンクできるように最後に書き込まれます。プロバイダーのレート制限で失敗したワーカーは、実行の残りの部分の並列処理を1つ減らします。書き込み中のページは復元され、次の更新で処理されます。
LangChainは一時的なプロバイダーエラーを処理します。リトライ試行はデフォルトで3ですが、OPENWIKI_PAGE_CONCURRENCYが1より大きい場合は5になります。OPENWIKI_PROVIDER_RETRY_ATTEMPTS=3(正の整数)でオーバーライドできます。
LangSmithトレーシングがオンの場合、プランナーと各ページワーカーは個別のトレースであり、実行ごとに1つのLangSmithスレッドにグループ化されます。スレッドIDは実行のIDであり、再開された実行はこれを保持します。実行のトリガーとなったコミットからスレッドを見つけられるように、CIからOPENWIKI_TRACE_THREAD_IDを設定します。
ローカル状態ディレクトリ
OpenWikiは、ローカル認証情報、パーソナルウィキ、コネクターデータ、会話履歴、およびスキルをデフォルトで~/.openwikiの下に保存します。別の書き込み可能なディレクトリを使用するには、OpenWikiを開始する前にOPENWIKI_CONFIG_DIRを設定します。例えば、マウントされたコンテナボリュームなどです:
OPENWIKI_CONFIG_DIR=/data/openwiki openwiki personal --init
このオーバーライドは、個別の状態ディレクトリを選択します。OpenWikiは既存の~/.openwikiディレクトリを移動または削除しません。保存したい状態を自分でコピーし、OpenWikiが現在のユーザーに対して権限を制限するため、専用ディレクトリに変数をポイントしてください。
あなたのものとして維持する方法
あなたのウィキはリポジトリ内にプレーンなMarkdownとして保持され、OpenWikiが管理する根拠付けと実行メタデータが一緒にバージョン管理されます。
- エージェントはコンテキストとして読み取ります。 各
code実行で、OpenWikiはリポジトリのルートにAGENTS.mdを維持し、リポジトリに既にCLAUDE.mdが存在する場合はそれをリフレッシュします。Claude CodeはCLAUDE.mdが存在しない場合にAGENTS.mdを読み取るため、OpenWikiはCLAUDE.mdを作成しません。管理された指示は、利用可能な場合の具体的な質問に対して選択的かつ段階的なopenwiki_search/openwiki_read検索を使用し、フォールバックとしてopenwiki/quickstart.mdを使用します。OpenWikiは、<!-- OPENWIKI:START -->…<!-- OPENWIKI:END -->ブロックのみを書き換え、各ファイルの残りは変更しません。 - 根拠付けはウィキと共に残ります。
openwiki/.claims/の下のバージョン管理されたClaimサイドカーはMarkdownと共に移動するため、事実ページを維持するために必要な証拠は検査可能でレビュー可能です。 - あなたは概要を設定します。 リポジトリ固有の指示は
openwiki/INSTRUCTIONS.mdにあり、これはユーザー作成ファイルで、OpenWikiはスコープと優先順位のためにこれを読み取りますが、通常の実行中に書き換えることはありません。 - No-op実行はドキュメントを乱しません。 クリーンな更新はモデル作業をスキップし、ウィキコンテンツを変更せずに
.last-update.jsonを更新してチェックが実行されたことを記録します。 - ローカル、プライベート設定。 プロバイダーの選択、キー、およびオプションのLangSmithトレーシングは、お使いのマシン上の
~/.openwiki/.envに保存されます。
パスの無視
リポジトリのルートに.openwikiignoreファイルを作成して、生成されたドキュメントがプライベート、生成済み、または無関係なパスを読み取ったり説明したりしないようにします。構文は、コメント、空行、*および**グロブ、ディレクトリルール、および!否定をサポートします:
secrets/
*.log
!logs/keep.log
.openwikiignoreにアクティブなルールがある場合、OpenWikiはファイルシステムの検出をフィルタリングし、シェル実行を制限して、無視されたパスが実行から除外されるようにします。これは読み取り境界です。無視されたパスは決して読み取られたり、スキャンされたり、ドキュメントに再現されたりしません。エージェントが他の許可された証拠(テスト、README、コミットメッセージなど)から無視された領域を推測する可能性があるため、トピックが決して言及されないことを保証するものではありません。
仕組み
OpenWikiは、リポジトリの調査と書き込みを、ウィキの一貫性を保つための事務処理から分離します。リポジトリページはソース証拠を保持し、完了した作業は将来の更新のために保存されます。
OpenWikiアーキテクチャ
リポジトリ生成は、独立して永続化可能なページジョブの順序付けられたキューに従います。ネイティブCLI実行は適格なページを並列処理できます。コーディングエージェント統合はキューをシーケンシャルに消費します。openwiki/.run.jsonはアクティブな実行とその進捗をチェックポイントします。ページは、Markdown、Claim、検証、およびopenwiki/.page-manifest.jsonエントリが永続化された後にのみ進みます。これにより、中断や将来の実行を越えて完了した作業とページ固有のソースベースラインが保持されます。
根拠のある主張(Grounded Claims)
OpenWikiは、各リポジトリページの背後にある事実を根拠のある主張(Grounded Claims)として追跡します。各Claimは、repo://src/server.ts#L40-L82のようなバージョン管理されたソース証拠を指します。その証拠が変更または消失した場合、OpenWikiはどの事実が確認、書き直し、または引退される必要があるかを特定します。
[画像: OpenWiki Claims reconcile code evidence into OKF page-level trust metadata.]
Claimの調整と永続化の方法
Claimは、将来のエージェントが信頼する真実(動作、責任、アーキテクチャ、データフロー、不変条件、障害セマンティクス、構成、セキュリティ境界)をカバーします。各Claimは、Markdownファイルが最後に生成されたときだけでなく、Claimが確立されたときに観測された証拠バージョンを記録します。
更新の前に、OpenWikiはすべての永続化された証拠バージョンをチェックし、リポジトリがNo-opであるかどうかを判断する前にチェックします。 стаale または解決されていないClaimは、プランナーがそれを省略した場合でも、その所有ページに作業を要求します。ページワーカーは、注意が必要なClaimのみを受け取ります。問題のない現在のClaimは、すべてのモデルターンで繰り返し繰り返されることなく、決定論的に保持されます。ワーカーは、再チェックされた問題のあるClaimを明示的に確認し、修正と追加のみを送信し、撤回を名前付けします。完全な現在のClaimは、オンデマンド検査を通じて広範な書き換えのために利用可能です。Markdownはクリーンに保たれます。構造化されたClaim状態は、openwiki/.claims/の下に並んで存在します。
ページの完了は永続化の境界です。OpenWikiは、調整されたClaim、プロジェクト検証を永続化し、サイドカーのページバージョンを同期し、完了した結果を証明してから、そのページのジョブを完了としてマークします。最終化は、openwiki/.run.jsonを削除する前に、全体的な実行証明を繰り返します。
根拠のあるClaimは現在、リポジトリコードウィキとリポジトリ証拠に適用されます。コネクターから派生した事実は、LangSmithのみの観測を含む、Claimされません。
Open Knowledge Format (OKF v0.2)
OpenWikiは、両方のモードでGoogle Open Knowledge Format (OKF) v0.2バンドルを出力するため、ウィキはOKF対応ツールにポータブルです。
フロントマター、出所、および検証メタデータ
- すべてのコンセプトドキュメントは、空でない
typeを持つYAMLフロントマターを運びます。他のすべての標準フィールドはオプションです。 - 新しく初期化されたページには
generated: {by, at}が付与されます。更新中、ボディの変更(空白文字を含む)はスタンプを進めます。変更されていないボディは前のイベントを保持し、フロントマターのみの変更はそれを進めません。プロデューサーはopenwiki/<version>(またはコーディングエージェントホスト)としてスタンプされ、出所が明示されます。レガシーv0.1のtimestampフィールドは、既存のページでも引き続き許容されます。 - リポジトリページは、その根拠のあるClaim証拠を
sourcesに投影します。OpenWikiは、独立して作成されたソースを保持しながら、決定論的に識別されたエントリを調整します。 - リポジトリページには、
verified: {by: openwiki/<version>, at: ...}が付与されます。これは、ページの提出が空でない完全なClaimセットを調整し、最終証拠の再チェックに合格し、Claimサイドカーを永続化した後にのみ行われます。クリーンなプリフライトだけでは検証が作成または進められることはなく、人間やその他のプロセスのイベントは保持されます。 - オプションのv0.2出所、信頼、およびライフサイクルファミリー(
sources、verified、status、stale_after)は、存在する場合に検証されます。 - コンセプトドキュメント間の標準Markdownリンクは、それらの関係を表現します。
index.mdとlog.mdはコンセプトではなく予約済みドキュメントです。ルートインデックスはokf_version: "0.2"を宣言します。- プロデューサー定義の拡張フィールドは、更新および移行を越えて保持されます。
ダイアグラム
OpenWikiは、プロセスの説明よりも概念を明確にする場合に、Mermaidダイアグラムを埋め込みます。実行フローのシーケンスダイアグラム、データモデルのERダイアグラム、ライフサイクルのステートダイアグラム、および制御フローのフローチャートです。ダイアグラムは検査されたソースに根拠を持ち、信号を追加する場所に配置され、--updateで同期が保たれます。設定は不要です。
ダイアグラムの検証と修復
各実行後、OpenWikiはすべてのmermaidフェンスを検証します。検証に失敗したダイアグラムは、その理由を説明する短いコメントとともにプレーンなtextフェンスに変換され、壊れたブロックではなく読み取り可能なテキストに劣化します。次の--updateは、そのコメントを見つけてダイアグラムを修復するため、 successive な実行で品質が回復します。
[!TIP] デフォルトでは、OpenWikiは一般的な破損を検出する軽量で依存関係のないチェックを実行します。GitHubがレンダリングするものと正確に一致する権威ある検証のために、OpenWikiを実行する場所(例えばスケジュールされたワークフロー内)にMermaidパーサーをインストールしてください。そうすれば、壊れたダイアグラムは出荷されません:
npm install mermaid jsdom
## ソースの接続
リポジトリドキュメントを超えて、OpenWikiには9つの組み込みコネクターがあります。`personal`モードでは、OpenWikiは既に使用しているツールから知識を取り込み、それらをローカルウィキに統合します。初回実行のオンボーディングでは、**カスタムMCP、ローカルgitリポジトリ、Notion、Gmail、X/Twitter、Web検索、およびHacker News**のセットアップが提供されます。SlackもOAuthアプリとHTTPSコールバックを設定すれば利用可能です。
`openwiki personal --init`でパーソナルウィキを開始し、必要に応じてソースを認証して取り込みます:
openwiki auth notion # プロバイダーのローカルブラウザOAuthフローを実行
openwiki ingest all # 設定されたすべてのソースを実行
openwiki ingest web-search # 1つのコネクターのソースを実行
**コネクターの詳細とOAuth**
取り込み実行中、決定論的なコネクターツールは`~/.openwiki/connectors/<connector>/raw/`の下に生のデータとマニフェストを書き込み、その後、ソース固有のエージェント実行が`~/.openwiki/wiki/`の下にウィキを合成します。同じコネクターを複数回設定できます(例:AIリサーチ用とNBAニュース用で1つのWeb検索ソース)。OpenWikiはそれらを`web-search-1`や`web-search-2`のような個別のインスタンスとして保存します。
- `git-repo`は設定されたローカルリポジトリパスを読み取り、コンパクトなマニフェストを書き込みます。
- `custom-mcp`は設定されたHTTPまたはstdio MCPサーバーに接続し、明示的に安全な読み取り専用ツールのみを許可します。
- `x`はX APIをOAuthユーザーコンテキスト認証情報で直接使用し、ホームタイムライン、ユーザー投稿、メンション、ブックマーク、リスト投稿を取得します。
- `notion`はホストされたNotion MCPサーバーをターゲットとするため、トークンを貼り付けるのではなくNotion OAuthで認証します。
- `google`はGmail APIをOAuthユーザー認証情報で直接使用し、最近のメールを取得します。
- `slack`はSlackのWeb APIをOAuthユーザーおよびボットトークンで使用し、スコープ付き会話と検索結果を取り込みます。
- `web-search`はTavilyをLangChain経由で使用し、`TAVILY_API_KEY`が必要です。
- `hackernews`は公開Hacker Newsフィードと検索APIを使用し、認証情報は不要です。
`openwiki auth <provider>`はローカルブラウザOAuthフローを実行し、返されたトークンを`~/.openwiki/.env`に保存し、可能な場合はコネクターを設定し、MCPバックエンドプロバイダーの場合はMCPツールを検出します。SlackとGmailは、これらのファイルにアプリクライアント認証情報が既に設定されている必要があります。NotionはホストされたMCPのために動的なクライアント登録を使用します。XはPKCEを使用したOAuth 2.0を使用します。`openwiki auth configure <provider>`と`openwiki auth tools <provider>`は高度なリトライコマンドです。
コネクターシークレットは環境変数名で参照され、`~/.openwiki/.env`に保存されます。コネクター設定ファイルには生のシークレット値は含まれません。
**Slack OAuthトンネル。** `openwiki ngrok start`はランダムなHTTPS転送URLを持つngrokトンネルを開始し、ngrokのローカル検査APIを読み取り、`/callback`を追加して、`OPENWIKI_HTTPS_OAUTH_REDIRECT_URI`を自動的に保存します。Slackで印刷されたコールバックURLを登録します。固定ドメインがある場合は、`openwiki ngrok start https://<your-ngrok-domain>`を実行します。
### LangSmithコネクター(コードモード)
上記のコネクターは`personal`ウィキにフィードしますが、**LangSmith**コネクターは代わりに`code`ウィキを強化します。公式LangSmith SDKを通じて選択したプロジェクトの最近のLangSmithトレース(ツール呼び出し、結果、レイテンシ)を取得するため、リポジトリのドキュメントは、ソースが言うことだけでなく、コードが実際に実行時にどのように動作するかを反映します。
**LangSmithプロジェクト、リージョン、および認証情報の構成**
`code`モードでの`openwiki --init`中に設定します。ソースメニューからLangSmithを追加し、ワークスペースリージョン(US、EU、またはAPAC)を選択し、ドキュメント化するプロジェクトをリストします。OpenWikiは、すべてのチームメイトとCI実行が同じセットをドキュメント化できるように、ワークスペースとプロジェクトの名前のみを記録するコミットされた`openwiki/.langsmith.json`を書き込みます(キー自体は決して記録しません)。APIキーは環境から読み取られます:
OPENWIKI_LANGSMITH_API_KEY="<your-langsmith-key>"
ローカルではセットアップウィザードがこれを`~/.openwiki/.env`に保存します。CIでは、リポジトリシークレットとして設定し、実行のためにエクスポートします。
> [!NOTE] LangSmithキーはワークスペースおよびリージョンにバインドされています。複数のワークスペースにまたがるプロジェクトをドキュメント化するには、ワークスペースごとにエントリを追加し、それぞれに`OPENWIKI_LANGSMITH_API_KEY_2`、`OPENWIKI_LANGSMITH_API_KEY_3`などのキーを付けます。コネクターは、公式のUS(`api.smith.langchain.com`)、EU(`eu.api.smith.langchain.com`)、およびAPAC(`apac.api.smith.langchain.com`)ホストのみと通信します。
## モデルプロバイダー
これらの設定は、OpenWikiを直接実行する場合に適用されます。コーディングエージェント統合は、ホストの認証済みモデルセッションを使用します。
OpenWikiは14のプロバイダーをサポートしています。オンボーディングのデフォルトはOpenAIで`gpt-5.6-terra`を使用します。利用可能なプリセットモデルから選択するか、カスタムモデルIDを指定します。プロバイダー認証情報は`~/.openwiki/.env`に保存されます。
| プロバイダー | 認証情報 |
| --- | --- |
| **OpenAI**(デフォルト) | `OPENAI_API_KEY` |
| **OpenAI (ChatGPTログイン)** | ブラウザサインイン、ChatGPTプランを使用 |
| **Anthropic** | `ANTHROPIC_API_KEY` |
| **IBM Bob** | `BOB_API_KEY` |
| **Gemini** (AI Studio) | `GEMINI_API_KEY` |
| **Gemini Enterprise** (Vertex AI) | Google ADC、キーレス |
| **AWS Bedrock** | IAM認証情報 |
| **GitHub Copilot** | GitHub CLIセッション |
| **OpenRouter** | `OPENROUTER_API_KEY` |
| **Nebius / Fireworks / Baseten / NVIDIA NIM** | プロバイダーAPIキー |
| **OpenAI互換** (LiteLLM, Ollama, LM Studio, ゲートウェイ) | ベースURL + キー |
**GitHub Copilot**
GitHub Copilotプロバイダーは、メーター付きAPIキーをプロビジョニングする代わりに、既存のCopilotサブスクリプションを再利用できるように、推論をOpenAI互換Copilot API(`https://api.githubcopilot.com`)にルーティングします。これは`openai`プロバイダーと同じモデルリストを提供します。
OpenAI互換プロバイダーとしてGitHub Copilotを選択
OPENWIKI_PROVIDER=copilot
OPENWIKI_MODEL_ID=gpt-5.5
`openwiki --init`中に`GitHub Copilot`を選択します。アクティブな[GitHub CLI](https://cli.github.com/)セッションがある場合、OpenWikiはそれを検出し、再利用を提案します。それ以外の場合は、認証情報プロンプトでTabキーを押して`gh auth login`を実行し、サインインします。
OpenWikiはトークンをGitHub CLI自身の認証情報ストアに保存します。CIやその他のヘッドレス環境では、`COPILOT_API_KEY`をGitHub **OAuthトークン**に設定します。パーソナルアクセストークンは、サードパーティ統合ではCopilot APIによって拒否されます。ローカル設定はトークンなしで維持できます:
OPENWIKI_PROVIDER="copilot"
OPENWIKI_MODEL_ID="gpt-5.5"
CIでは、`COPILOT_API_KEY`リポジトリシークレットを設定し、実行のために`OPENWIKI_PROVIDER=copilot`をエクスポートします。
**AWS Bedrock**
`bedrock`プロバイダーは、単一のベンダーキーではなくIAM認証情報を使用してAWS Bedrock上の基盤モデルを呼び出します:
OPENWIKI_PROVIDER=bedrock
BEDROCK_AWS_ACCESS_KEY_ID=your-access-key-id
BEDROCK_AWS_SECRET_ACCESS_KEY=your-secret-access-key
BEDROCK_AWS_REGION=us-east-1
OPENWIKI_MODEL_ID=anthropic.claude-sonnet-5
明示的なBedrock認証情報が設定されていない場合、OpenWikiはIAMロール、AWSプロファイル、ECS/EC2、OIDC/Web IDのAWS SDKデフォルト認証情報プロバイダーチェーンを使用します。リージョンは`BEDROCK_AWS_REGION`、`AWS_REGION`、または`AWS_DEFAULT_REGION`から解決されます。利用可能なモデルIDは、アカウントとリージョンで有効になっている基盤モデルによって異なります。そのため、プリセットリストはありません。BedrockモデルIDを直接貼り付けてください。
一部の新しいモデルは、クロスリージョン推論プロファイルを通じてオンデマンド呼び出しのみを受け入れます。`ValidationException: Invocation of model ID ... with on-demand throughput isn't supported`というエラーが表示される場合は、モデルIDの前にプロファイルのリージョンコードを付けます(例:`us.anthropic.claude-sonnet-5`)。IAMポリシーは、`foundation-model`と`inference-profile`リソースタイプの両方に対して`bedrock:InvokeModel` / `InvokeModelWithResponseStream`も必要になります。
**Gemini (AI Studio) および Gemini Enterprise (Vertex AI)**
**Gemini (AI Studio)**は、単一のAPIキーでGoogleのGeminiモデルを実行します:
OPENWIKI_PROVIDER=gemini
GEMINI_API_KEY=your-ai-studio-key
**Gemini Enterprise**は、Gemini Enterprise Model Garden(旧Vertex AI)のモデルを実行します。GoogleのGemini/Gemma、AnthropicのClaude、およびパートナー/オープンウェイトモデル(Llama、Mistral、DeepSeek、Qwen)です。各モデルIDを適切なAPIサーフェスに自動的にルーティングし、APIキーは使用しません。認証はGoogle Application Default Credentials(ADC)で行われます:
- `GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json`を介したサービスアカウントキーファイル、
- `gcloud auth application-default login`からのユーザー認証情報、または
- Google CloudまたはCIで実行中の場合のワークロードID。
OPENWIKI_PROVIDER=gemini-enterprise
GOOGLE_CLOUD_PROJECT=your-gcp-project
GOOGLE_CLOUD_LOCATION=global # オプション、デフォルトはglobal
`OPENWIKI_MODEL_ID`を任意のModel Gardenモデルに設定します。GeminiとClaudeはプリセットとして提供されます。パートナーモデルは、IDを貼り付けることでアクセスできます(例:`publishers/meta/models/llama-3.3-70b-instruct-maas`)。認証情報にはVertex AIアクセス(`roles/aiplatform.user`)が必要であり、モデルはModel Gardenで有効になっている必要があります。`global`エンドポイントは、利用可能性が最も高いGeminiとClaudeを提供します。データレジデンシーのためにリージョンエンドポイントに`GOOGLE_CLOUD_LOCATION`を設定し、リージョン固有のパートナー(MaaS)モデルの場合は常に明示的に設定します。
CIの場合、更新ジョブの前に認証を行い(例:[`google-github-actions/auth`](https://github.com/google-github-actions/auth)を使用)、ジョブ環境で`OPENWIKI_PROVIDER=gemini-enterprise`と`GOOGLE_CLOUD_PROJECT`を設定します。
**OpenAI (ChatGPTログイン)**
`openai-chatgpt`プロバイダーは、メーター付きAPIキーの代わりにChatGPTサブスクリプションを使用してOpenAIのCodexバックエンドを呼び出し、Plus/Pro/Teamプランに含まれるCodex使用量を利用します。これは`openai`プロバイダーと同じモデルリストを提供します。
OPENWIKI_PROVIDER=openai-chatgpt openwiki code --init
または
OPENWIKI_PROVIDER=openai-chatgpt openwiki personal --init
ウィザードはブラウザで`https://auth.openai.com`を開きます(ヘッドレス/SSH使用の場合はURLを印刷します)。サインイン後、OpenWikiはOAuthコールバックをキャプチャし、サインインしたメールとプランを表示して、モデル選択に進みます。アクセス トークン、リフレッシュ トークン、有効期限、アカウントID、メール、プランを`~/.openwiki/.env`に保存します。これらは自動的に管理され、アクセス トークンは自動的にリフレッシュされるため、通常は手動で編集する必要はありません。リフレッシュ トークンはパスワードのように扱ってください。
**OpenAI互換エンドポイント(LiteLLM, Ollama, LM Studio, ゲートウェイ)**
`openai-compatible`プロバイダーは、必須のベースURLを介して任意のOpenAI互換チャットコンプリーションエンドポイントをターゲットにします。モデルIDは、エンドポイントが公開しているものに設定します。
ホストされたゲートウェイ(例:Requesty、多くのアップストリームプロバイダーをフロントエンド化)
OPENWIKI_PROVIDER=openai-compatible
OPENAI_COMPATIBLE_API_KEY=your-gateway-key
OPENAI_COMPATIBLE_BASE_URL=https://router.requesty.ai/v1
OPENWIKI_MODEL_ID=openai/gpt-5.5
EUホストゲートウェイ(例:Opper、1つのキーで700以上のモデルを提供)
OPENWIKI_PROVIDER=openai-compatible
OPENAI_COMPATIBLE_API_KEY=your-opper-key
OPENAI_COMPATIBLE_BASE_URL=https://api.opper.ai/v3/compat
OPENWIKI_MODEL_ID=claude-sonnet-4-6
Ollama、ollama serveおよびollama pull llama3.2の後
OPENWIKI_PROVIDER=openai-compatible
OPENAI_COMPATIBLE_API_KEY=ollama
OPENAI_COMPATIBLE_BASE_URL=http://localhost:11434/v1
OPENWIKI_MODEL_ID=llama3.2
LM Studio、開発者タブからローカルサーバーを起動した後
OPENWIKI_PROVIDER=openai-compatible
OPENAI_COMPATIBLE_API_KEY=lm-studio
OPENAI_COMPATIBLE_BASE_URL=http://localhost:1234/v1
OPENWIKI_MODEL_ID=your-loaded-model-id
一部のローカルサーバーはAPIキー値を無視しますが、APIキーモードではクライアントがそれを期待するため、`OPENAI_COMPATIBLE_API_KEY`が必要です。
**Microsoft Entra IDゲートウェイ。** 対話型`openwiki --init`中に、OpenAI互換を選択し、次にMicrosoft Entra IDを選択します。HTTPS APIルート、ゲートウェイが受け入れるトークンスコープ、およびモデルIDを入力します。OpenWikiはこれらの設定を後続の`--update`実行のために保存します。アクセス トークンを要求したり保存したりしません。Azure Identityは、OpenWikiを実行する各環境で個別に構成する必要があります。非対話型実行の場合、同じ値を明示的に設定します:
OPENWIKI_PROVIDER=openai-compatible
OPENAI_COMPATIBLE_AUTH=entra-id
OPENAI_COMPATIBLE_BASE_URL=https://gateway.example.com/openai/v1
OPENAI_COMPATIBLE_ENTRA_SCOPE=api://gateway-application-id/.default
OPENWIKI_MODEL_ID=your-gateway-model
`OPENAI_COMPATIBLE_ENTRA_SCOPE`は、Azure OpenAIの場合はデフォルトで`https://cognitiveservices.azure.com/.default`になります。カスタムゲートウェイでは異なるスコープが必要になる場合があります。Azure Identityはモデルリクエスト時にベアラートークンを取得およびリフレッシュするため、Entraモードでは`OPENAI_COMPATIBLE_API_KEY`は必要ありません。生成されたCIワークフローはモードとスコープを保持しますが、CIで非監視型Azure Identity認証情報を構成する必要があります。
ワークロードIDフェデレーションの場合、OpenWikiを実行する環境で`AZURE_CLIENT_ID`、`AZURE_TENANT_ID`、および`AZURE_FEDERATED_TOKEN_FILE`を指定します。ファイル変数はランナー提供のフェデレーショントークンファイルを指す必要があります。トークンをOpenWikiに貼り付けたり、ファイルをコミットしたりしないでください。ファイル変数が設定されている場合、OpenWikiはデフォルトチェーンの他の認証情報ではなく`WorkloadIdentityCredential`を使用します。設定されていない場合、OpenWikiは`DefaultAzureCredential`を使用します。
**ストリーミング専用ゲートウェイ。** 一部のゲートウェイはストリーミングトランスポートのみを提供します。非ストリーミングリクエストは、完全に拒否される(`Stream must be set to true`)か、HTTP 200と空のコンテンツで応答され、結果として空のウィキとエラーなしになります。OpenWikiは内部的に非ストリーミングリクエストを発行するため、それらのエンドポイントではストリーミングトランスポートを強制します:
OPENWIKI_OPENAI_COMPATIBLE_STREAMING=true
これはデフォルトではオフになっています。このプロバイダーは任意のサードパーティエンドポイントをターゲットにしており、SSEはプロキシやロードバランサーを通過しない可能性があるためです。これを有効にすると、クライアントはサーバー報告のトークン数ではなく、推定トークン数を報告します。
**推論対応ゲートウェイ。** OpenAI互換エンドポイントはユーザー提供であるため、OpenWikiは任意のモデルが推論制御をサポートしているとは想定しません。ゲートウェイがOpenAIスタイルの推論努力を受け入れる場合、`OPENWIKI_REASONING_EFFORT`を設定する前に明示的にオプトインします:
OPENWIKI_OPENAI_COMPATIBLE_REASONING_EFFORT_SUPPORTED=true
OPENWIKI_REASONING_EFFORT=high
`OPENWIKI_OPENAI_COMPATIBLE_USE_RESPONSES_API=true`も設定されている場合、努力はResponses APIの推論フィールドで送信されます。それ以外の場合は、チャットコンプリーションの`reasoning_effort`モデル引数として送信されます。
**代替ベースURL、OpenRouterピン留め、およびリトライ**
**代替ベースURL。** プロバイダーをセルフホストまたはプロキシされたゲートウェイにルーティングするには、キーと共にベースURLを設定します:`ANTHROPIC_BASE_URL`、`OPENAI_BASE_URL`、`BASETEN_BASE_URL`、`FIREWORKS_BASE_URL`、`NVIDIA_BASE_URL`、または`COPILOT_BASE_URL`。`openai`プロバイダーは、Responses API(`/v1/responses`)を介してツール呼び出しをルーティングします。これは、それを公開するゲートウェイに役立ちます。
OPENWIKI_PROVIDER=anthropic
ANTHROPIC_API_KEY=your-key
ANTHROPIC_BASE_URL=https://your-gateway.example.com/anthropic
**OpenRouterプロバイダーのピン留め。** OpenRouterが複数のアップストリームを介してモデルを提供する場合、プロバイダーまたはカンマ区切りの許可リストでルーティングを制限します:
OPENWIKI_PROVIDER=openrouter
OPENROUTER_API_KEY=your-key
OPENWIKI_OPENROUTER_PROVIDER_ONLY=Novita
**出力トークン制限。** OpenWikiは、最新のClaude 4/5モデル用にリクエストあたり16,384トークンのデフォルトを使用します。これは、古いLangChainモデルメタデータが新しいClaudeエイリアスを4,096トークンに制限するためです。選択されたモデルのプロバイダーニュートラルな制限を設定します:
OPENWIKI_MAX_OUTPUT_TOKENS=16384
OpenWikiはこの設定を選択されたプロバイダーのリクエスト形状にマッピングします。カスタムモデルは、OpenWikiがサポートされる出力ウィンドウを知らないため、それ以外の場合はプロバイダーまたはSDKのデフォルトを保持します。
**OpenRouter出力トークンキャップ。** デフォルトでは`max_tokens`は送信されないため、OpenRouterのクレジット事前チェックはモデルの完全な広告出力上限を予算計上します。クレジット残高が少ない場合、すべてのリクエストが402エラーで失敗する可能性があります。既存のインストールは、次のようにOpenRouter固有のキャップを保持できます:
OPENWIKI_OPENROUTER_MAX_TOKENS=8192
OpenRouter固有の設定は、OpenRouter実行の場合、`OPENWIKI_MAX_OUTPUT_TOKENS`よりも優先されます。キャップは、ハードな402エラーを、ウィキ生成が実際にそれ以上の出力トークンを必要とする場合の切り捨ての可能性と交換するため、残高で許可される最大値を選択してください。
ネイティブワーカーの並列処理とプロバイダーのリトライ設定については、[並列ページワーカー](https://github.com/langchain-ai/openwiki#parallel-page-workers)を参照してください。
**Bedrockストリームアイドルタイムアウト。** Bedrockプロバイダーの場合、`OPENWIKI_STREAM_IDLE_TIMEOUT`を設定して、クライアントが最初のチャンクまたは次のストリーミング応答チャンクを待つ時間を制御します(例:`OPENWIKI_STREAM_IDLE_TIMEOUT=300000`)。値はミリ秒で、`0`から`2147483647`までの整数である必要があります。ウォッチドッグを無効にするには`0`に設定します。設定されていない場合、OpenWikiは`@langchain/aws`プロバイダーのデフォルトを保持します。ハングし続けるストリームを防ぐために、ウォッチドッグを無効にするよりも十分に長い有限タイムアウトを優先してください。
**推論努力。** サポートされているプロバイダーとモデルの推論を構成するには、`OPENWIKI_REASONING_EFFORT`を設定します。OpenAI GPT-5.6モデルは、Responses APIの値`none`、`low`、`medium`、`high`、`xhigh`、`max`を使用します。Gemini 3.6 Flashは、Geminiの思考レベルに`low`、`medium`、`high`をマッピングします。NVIDIA NIMのNemotron 3 Superは`none`、`low`、`high`をサポートします。対話型チャットでは、`/effort`を使用して利用可能な値を選択するか、`/effort default`でプロバイダーデフォルトを復元します。変数を設定しないでおくと、プロバイダーデフォルトが保持されます。無効なプロバイダー、モデル、または努力の組み合わせは、リクエストが送信される前に失敗します。
注意
追加してほしい推論プロバイダーまたはモデルがある場合は、PRを開いてください。
## コマンドリファレンス
openwiki # 対話型チャット、コードモード、現在のリポジトリ
openwiki personal # 対話型チャット、パーソナルブレイン
openwiki "generate docs" # 初期リクエストで開始
openwiki -p "what can you do?" # ワンショット、印刷して終了
openwiki --init # コードドキュメントの初期化(パーソナル:openwiki personal --init)
openwiki --update # コードドキュメントの更新(パーソナル:openwiki personal --update)
openwiki visualize # 対話型グラフ + ライブリーダー
openwiki visualize openwiki --export docs/openwiki-visualizer # 静的グラフ + リーダー
openwiki link [directory] # 名前付きウィキワークスペースの作成と管理
openwiki workspace use <name> # 現在のリポジトリのアクティブワークスペースを設定
openwiki workspace current|clear # アクティブワークスペースの検査またはクリア
openwiki auth <provider> # コネクターの認証(slack, gmail, x, notion)
openwiki ingest <source> # コネクター取り込みの実行(all、またはコネクター/インスタンス)
openwiki integrations list # インストールされているコーディングエージェント統合を表示
openwiki integrations install <bob|codex|claude|opencode|cursor|kiro|omp|antigravity|copilot> [--project [path]]
openwiki integrations uninstall <bob|codex|claude|opencode|cursor|kiro|omp|antigravity|copilot> [--project [path]]
openwiki --help # 完全なヘルプ
チャットでは、`/api-key`は現在のプロバイダーキーを更新し、`/langsmith-key`はマスクされたプロンプトでLangSmithトレーシング認証情報を更新またはクリアします。
## テレメトリ
OpenWikiは、ツールの使用方法を理解し改善するために、匿名で集計された使用データを収集します。テレメトリはデフォルトでオンになっており、簡単にオフにできます。
単一の`openwiki_run`イベントで**収集されるもの**(`~/.openwiki/install-id`のランダムなインストールIDでキー付け):コマンド(init / update)、結果(成功/失敗/no-op、失敗時の大まかなエラーカテゴリ(メッセージは決して収集されない))、およびセットアップ時のみ、ブレインモード、モデルプロバイダー、設定されたコネクター名。
**収集されないもの:** ファイルコンテンツ、リポジトリデータまたは名前、認証情報、プロンプト、モデル出力、コネクターペイロード、エラーメッセージ、ファイルパス、URL、モデルID、実行時間、またはIPアドレス。対話型チャット、`auth`、および`ingest`は記録されません。スケジュールされた/CI実行は、共有CI識別子の下で匿名信頼性データとしてタグ付けされ、インストールとしてはカウントされません。
環境変数のいずれかを使用してオプトアウトするか、`~/.openwiki/.env`に最初の行を追加して永続的に無効にします:
export OPENWIKI_TELEMETRY_DISABLED=1
export DO_NOT_TRACK=1 # クロツール標準
実行が送信する内容を正確に確認するには、任意の実行に`--telemetry-file=<path>`を追加します。
## 貢献
貢献を歓迎します。PRを開く前に[CONTRIBUTING.md](https://github.com/langchain-ai/openwiki/blob/main/CONTRIBUTING.md)をお読みください。PRは意図的に1つの変更に厳密にスコープされており、無関係な変更をバンドルしたPRは分割を求めるリクエストとともに閉じられる場合があります。
## ライセンス
[MIT](https://github.com/langchain-ai/openwiki/blob/main/LICENSE)