OpenWiki icon

OpenWiki

OpenWikiは、コードベースのドキュメントを生成・維持するCLIツールです。AGENTS.mdやCLAUDE.mdで文脈を共有し、リポジトリ文書を最新化します。

OpenWiki

概要

OpenWiki は、コードベース向けのドキュメントを生成・維持するための CLI で、特にエージェントがそのリポジトリで作業する際に役立つドキュメントに重点を置いています。README では、初期ドキュメントを作成し、コードベースの変更に合わせて最新状態を保ち、コーディングエージェントがコンテキストを探す場所を示すガイドファイルを追加するツールとして説明されています。

実際には、OpenWiki は開発者のワークフローに組み込むことを想定しています。npm でインストールし、リポジトリで初期化したうえで、対話的に実行するか、一度きりの要約を生成します。さらに、このプロジェクトには、スケジュールに基づいてドキュメント更新のプルリクエストを開ける GitHub Actions のワークフローも含まれており、リポジトリ文書を長期的に同期しやすくします。

OpenWiki の機能

コマンドライン中心のワークフロー

Web アプリではなく CLI として動作するため、ドキュメントの生成と更新をターミナルから行えます。

ドキュメントの生成と維持

wiki がまだ存在しない場合は openwiki/ ディレクトリに初期ドキュメントを作成し、その後はリポジトリの変更に合わせて内容を更新します。

対話モードと print モード

実行後に開いたままにして追加のプロンプトを受け付けることも、-p / --print で即終了して一括出力することもできます。

エージェント向けプロンプト案内

AGENTS.md や CLAUDE.md などのリポジトリ案内ファイルを更新し、エージェントを生成済みドキュメントへ誘導します。

複数のモデルプロバイダー

OpenRouter、Fireworks、Baseten、OpenAI、Anthropic を含む、複数の推論プロバイダーを標準でサポートします。

ローカル設定とトレース対応

必要に応じて、設定と LangSmith API key を ~/.openwiki/.env にローカル保存して、実行のトレースに利用できます。

主な使用例

  • リポジトリのドキュメントを立ち上げる

    新しいコードベースで、エージェントやコントリビューター向けの構造化された出発点が必要なときに、リポジトリ文書の初期版を生成します。

  • コードベースの進化に合わせてドキュメントを維持する

    OpenWiki を再実行するか、スケジュール更新 PR を開くリポジトリワークフローを使って、コード変更に合わせてエージェント向けドキュメントを整合させます。

  • エージェントのコンテキスト発見を改善する

    リポジトリ案内ファイルを生成済みの OpenWiki コンテンツにリンクし、コーディングエージェントがコンテキストを見つけやすくします。

  • 一度きりのドキュメント実行

    対話セッションを継続せずに、ターミナルから素早く要約やドキュメントのスナップショットを作成します。

  • 複数リポジトリで同じドキュメント手順を繰り返す

    同じ CLI セットアップとモデルプロバイダー設定に依存するプロジェクト間で、ドキュメントワークフローを標準化します。

Pros and Cons

Pros

  • エージェント向けのドキュメントに特化しており、一般的なプロジェクトメモだけにとどまりません。
  • 新規ドキュメントを初期化でき、リポジトリの変更から既存ドキュメントを更新できます。
  • 対話的な利用と、非対話の一括出力の両方に対応しています。
  • 主要な推論プロバイダーを複数、標準でサポートしています。
  • AGENTS.md や CLAUDE.md ファイルにドキュメント案内を組み込めます。

Cons

  • ソース資料には完全な機能一覧がないため、README だけでは一部の機能や制限がまだ不明です。
  • ドキュメント更新ワークフローは GitHub Actions とリポジトリの設定に依存するため、自動更新はその環境に紐づきます。

FAQ

OpenWiki はどのように使いますか?

OpenWiki は npm でインストールし、コマンドラインから起動します。README では、グローバルインストール用のコマンドのあとに、ドキュメント生成のための対話モード起動または一括出力の print モードが示されています。

OpenWiki はドキュメントを作成または更新しますか?

はい。README によると、OpenWiki は wiki がまだ存在しない場合に openwiki/ ディレクトリ内へ初期ドキュメントを作成し、すでにそのディレクトリがある場合はリポジトリの変更に応じてそのドキュメントを更新できます。

OpenWiki はどのモデルプロバイダーをサポートしていますか?

OpenWiki は OpenRouter、Fireworks、Baseten、OpenAI、Anthropic を標準でサポートしており、各推論プロバイダーごとにカスタムの model ID を指定できます。

OpenWiki は他のエージェントがドキュメントを見つけるのにどう役立ちますか?

README によると、OpenWiki は AGENTS.md や CLAUDE.md にプロンプト案内を追記できるため、コードエージェントがコンテキストを探す際に OpenWiki のドキュメントを参照するよう促せます。

OpenWiki は無料ですか?

このリポジトリ自体は GitHub 上でオープンソースとして公開されており、MIT ライセンスです。GitHub の料金ページには、公開リポジトリとプライベートリポジトリ向けの無料プランがあると記載されていますが、その料金ページは OpenWiki 自体の別個の有料価格を示すものではありません。

Quick Facts

カテゴリ
開発者ツール
製品タイプ
CLI
主な用途
コードベース向けのエージェント文書
インストール
npm install -g openwiki
ライセンス
MIT
リポジトリホスト
GitHub