OpenWiki でコードベースをリンク付き Markdown に変える
OpenWiki は、コードベースのエージェント ドキュメントを作成および管理する CLI です。
ひと目でわかる
- これは何？
- エージェントがソースを読み、リンク付き Markdown を更新し、ローカルのビジュアライザで探索する CLI の流れを確認します。
- 誰に向いている？
- コードベースや個人資料を継続的に文書化したいチームに向きます。実行前には入力コネクタ、モデルプロバイダー、資格情報の保存場所、生成されたリンクとダイアグラム、テレメトリ設定を確認してください。
- 商用利用できる？
- できます。MIT は寛容なライセンスで、著作権表示とライセンス表示を残せば、使用・改変・販売が可能です。
- 今もメンテナンスされている？
- されています。直近 1 日以内に新しいコミットがあります。
- 何の言語で書かれている？
- 主に TypeScript です（GitHub の言語統計による）。
回答はプロジェクトの GitHub データ（最終同期：2026年9月15日）と当サイトの分析に基づくもので、法的助言ではありません。
オープンソース詳細解説
自己維持型のMarkdownウィキ
OpenWikiは、コードベースまたは個人の知識のためのウィキを生成・維持するコマンドラインツールです。エージェントが指定したソースを読み取り、リンクされたMarkdownウィキを合成し、ソースの変更に合わせて更新します。出力はあなたが所有するプレーンなMarkdownで、コードと一緒にバージョン管理できます。2つのモードがあります: コードモードは現在のリポジトリを文書化し、そのリポジトリのopenwiki/に書き込みます。個人モードは接続されたソースを文書化し、~/.openwiki/wikiに書き込みます。READMEは、ウィキがエージェントがメモリとして読むために構築されており、人間向けのインタラクティブなビジュアライザが含まれていると述べています。
インストール、初期化、スケジュール更新
npm install -g openwikiでCLIをグローバルにインストールします。最初のopenwiki --init実行では、プロバイダ、キー、モデルを選択し、openwiki/にドキュメントを書き込みます。継続的な更新のために、READMEはGitHub Actions、GitLab CI、Bitbucket Pipelinesのサンプルワークフローファイルを提供しており、これらをリポジトリにコピーしてスケジュールします。Windowsでは、bunでのインストールは推奨されないとREADMEに記載されています。better-sqlite3ネイティブ依存関係のコンパイルにフォールバックする可能性があり、Visual Studioビルドツールが必要になるためです。
ビジュアライザでウィキを探索
ビジュアライザは、サイドバイサイドのMarkdownリーダーを備えたインタラクティブなノードグラフで、openwiki visualizeで起動します。ウィキをローカルループバックアドレス(127.0.0.1)で提供し、ネットワークに公開することはありません。サーバーはウィキファイルへの編集を自動的に拾います。ディレクトリパスを渡したり、--portでポートを選択したり(デフォルト4321)、--no-openでブラウザを開かないようにできます。READMEは、ページがグラフ、Markdown、ダイアグラムライブラリをパブリックCDNから読み込むため、サーバーがローカルでもインターネット接続が必要だと述べています。
ソースとコネクタ
個人モードでは、OpenWikiはローカルgitリポジトリ、Notion、Gmail、X/Twitter、Web検索、Hacker Newsから知識を取り込みます。各コネクタは生データとマニフェストを~/.openwiki/connectors/<connector>/raw/に書き込み、その後エージェントが~/.openwiki/wiki/の下でウィキを合成します。同じコネクタを複数のインスタンスとして設定できます。認証はopenwiki auth <provider>で処理され、ローカルブラウザのOAuthフローを実行し、トークンを~/.openwiki/.envに保存します。SlackはOAuthにngrokトンネルを使用します。LangSmithコネクタはコードモードで動作し、公式SDKを通じて選択したプロジェクトの最近のLangSmithトレース(ツール呼び出し、結果、レイテンシ)を取得し、コミットされたopenwiki/.langsmith.jsonを書き込みます。これはワークスペースとプロジェクトを指定しますが、APIキーは決して含みません。
出力形式とダイアグラム検証
OpenWikiはGoogle Open Knowledge Format (OKF) v0.1バンドルを出力します。概念ドキュメントには、空でないtypeを持つYAMLフロントマターが含まれます。他のフィールドはオプションです。index.mdとlog.mdは予約されたドキュメントであり、ルートインデックスはokf_version: "0.1"を宣言します。ウィキには、シーケンスフロー、ERモデル、状態図、フローチャート用のMermaidダイアグラムが含まれています。各実行後、すべてのmermaidフェンスが検証されます。検証に失敗したダイアグラムは、短いコメント付きのプレーンテキストフェンスにその場で変換され、次の更新で修復されます。GitHubのレンダラーと一致する信頼できる検証のために、OpenWikiの横にmermaidパーサーをインストールできます。
モデルプロバイダと資格情報
オンボーディングのデフォルトはOpenAIのgpt-5.6-terraです。12のモデルプロバイダがリストされています: OpenAI、Anthropic、Gemini (AI Studio)、Gemini Enterprise (Vertex AI)、AWS Bedrock、GitHub Copilot、OpenRouter、Nebius/Fireworks/Baseten/NVIDIA NIM、およびOpenAI互換のエンドポイント(LiteLLM、Ollama、LM Studio、ゲートウェイ)。各プロバイダにはプリセットモデルオプションがあり、カスタムモデルIDをサポートしています。資格情報は~/.openwiki/.envに保存されます。READMEは、Bedrock(IAM資格情報、リージョン解決)、Gemini Enterprise(Google ADC、APIキーなし)、OpenAI ChatGPTログイン(Codexバックエンド経由のOAuth)、OpenAI互換エンドポイントの詳細なセットアップを提供しています。代替ベースURLとOpenRouterプロバイダの固定も文書化されています。
プライバシー、テレメトリ、ライセンス
OpenWikiは生成されたドキュメントをプレーンなMarkdownとして保持し、リポジトリのルートにAGENTS.mdとCLAUDE.mdを維持し、自分のブロックだけを書き換えます。INSTRUCTIONS.mdはユーザーが作成し、通常の実行では決して書き換えられません。ノーオペレーションの実行は無料です。ツールは出力ディレクトリをスナップショットし、実際に変更があった場合のみ新しいメタデータを記録します。テレメトリは匿名で集約され、デフォルトでオンになっており、OPENWIKI_TELEMETRY_DISABLED=1またはDO_NOT_TRACK=1で無効にできます。READMEは収集されるもの(コマンド、結果、大まかなエラーカテゴリ、セットアップ時のブレインモード)と決して収集されないもの(ファイル内容、資格情報、プロンプト、出力、パス、URL)をリストしています。このプロジェクトはMITライセンスです。ライセンステキストは、コピーの使用、コピー、変更、マージ、公開、配布、サブライセンス、販売の権利を許可し、ソフトウェアは「現状のまま」提供され、いかなる保証もないと述べています。
編集部の結論
コードベースや個人資料を継続的に文書化したいチームに向きます。実行前には入力コネクタ、モデルプロバイダー、資格情報の保存場所、生成されたリンクとダイアグラム、テレメトリ設定を確認してください。OpenWiki は知識の正しさを保証する仕組みではなく、出力された Markdown のレビュー工程が必要です。
コミュニティノート