mcpField
G
grok-wiki-cli

grok-wiki-cli

github.com/asyncfuncai開発6743 回インストール10 週間前に更新
リポジトリ

grok-wiki-cli について

grok-wiki-cliは、公開されているgrok-wikiコマンドでリポジトリWikiを生成し、単一または複数のコードベースに質問するためのスキルです。クラウドモデルAPIではなく、利用可能なローカルCLIエージェントを使います。

主な機能

  1. 01GitHubまたはローカルソースからWikiを生成
  2. 02単一または複数のコードベースへの質問
  3. 03ローカルエージェントの準備状況確認
  4. 04保存済みWikiの一覧表示
  5. 05サーバー、worker、sidecarの起動

活用シーン

  1. 01GitHubリポジトリのWiki作成
  2. 02ワークスペース内のコードベース比較
  3. 03リポジトリ機能の実装方法の調査
  4. 04利用可能なローカルCLIエージェントの確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/asyncfuncai/grok-wiki --skill grok-wiki-cli

インストール後、Claude Code で/grok-wiki-cliを入力して読み込まれたか確認します。

同梱ファイルagents/openai.yaml

詳細

Grok-Wiki CLI

デスクトップ UI のクリック操作、サーバー API の直接呼び出し、プロバイダー固有のスクリプトではなく、公開されている grok-wiki コマンドを使うタスクでは、このスキルを使用します。

使用する場面

次の用途には grok-wiki を使用します。

  • GitHub の省略表記、GitHub URL、ローカルフォルダーからリポジトリの Wiki を生成する
  • 1 つのリポジトリまたは複数リポジトリのワークスペースを対象に、コードベースについて質問する
  • ローカル CLI エージェントが使用可能か確認する
  • ローカルに保存された Wiki を一覧表示する
  • ローカルサーバー、ワーカー、または local-cli サイドカーを起動する
  • Grok-Wiki CLI のコマンド体系を説明またはデバッグする

Grok-Wiki のソースコード自体を編集するタスクでは、ユーザーが CLI の使用を明示的に求めていない限り、grok-wiki を使用しないでください。

前提条件

  • まず公開されている grok-wiki コマンドを使用してください。
  • grok-wiki が利用できず、現在のリポジトリが Grok-Wiki の場合は、bun run ./bin/grok-wiki.ts を使用してください。
  • rlm-wiki は同じ CLI 動作をするレガシーエイリアスです。フォールバックとして、またはユーザーが指定した場合にのみ使用してください。
  • Wiki の生成と Ask は local-cli のみで実行します。これらのコマンドにプロバイダー API キーの確認を追加したり、クラウドモデル API 経由で実行したりしないでください。
  • ローカルエージェントがインストールされ、認証済みである必要があります。対象は grok、codex、claude、pi-codex、pi-claude、または antigravity です。

まず CLI とローカルエージェントが利用可能か確認します。

command -v grok-wiki || command -v rlm-wiki
grok-wiki agents --rescan

コマンドがインストールされていないものの、Grok-Wiki リポジトリ内にいる場合は、次を実行します。

bun run ./bin/grok-wiki.ts agents --rescan

利用可能なローカルエージェントがない場合は、grok-wiki agents --rescan で選択したエージェントのセットアップ手順を報告し、生成を開始せずに終了します。

基本的なワークフロー

  1. ソースを特定します。

    • GitHub の省略表記：owner/repo
    • GitHub URL：https://github.com/owner/repo
    • ローカルパス：./repo、/abs/path/repo、~/repo
    • ローカルパスの参照：~/repo#main

  2. エージェントが利用可能か確認します。

grok-wiki agents --rescan

  1. エージェントの動作を選択します。

    • --agent を省略すると、利用可能なローカル CLI エージェントのうち最初のものを使用します。
    • ユーザーが特定のローカルエージェントを選択した場合は、--agent <id> を指定します。
    • 選択したローカルエージェントが対応している場合にのみ、--model <model> と --reasoning <level> を指定します。

  2. generate、ask、または別のコマンドを実行します。

  3. 時間のかかる生成処理では、簡潔な進捗状況をユーザーに伝えます。コマンドが正常に終了し、Wiki の保存が報告されるまでは、成功したと伝えないでください。

コマンド体系

エージェント
grok-wiki agents --rescan

目的：ローカルサイドカーが利用可能か、また、どのローカルエージェントがインストール済みで、認証され、実行可能かを確認します。

対応するエージェント ID：

grok
codex
claude
pi-codex
pi-claude
antigravity
Wiki の生成
grok-wiki generate <source...> [--agent ID] [--model MODEL] [--reasoning LEVEL] [--pages N] [--page-count-mode auto|fixed] [--style STYLE] [--language LANG] [--concurrency N]

例：

grok-wiki generate expressjs/express
grok-wiki generate expressjs/express --agent codex --model gpt-5.5 --pages 8 --style first-30
grok-wiki generate ./api ./web --agent claude --page-count-mode fixed --pages 6
grok-wiki generate ~/work/repo#main --style custom --style-prompt "Write as an operator runbook."

デフォルト値：

  • エージェント：利用可能なローカル CLI エージェントのうち最初のもの
  • スタイル：first-30
  • ページ数：auto（最大 6）
  • 言語：en
  • 保存先：GROK_WIKI_ROOT または RLM_WIKI_ROOT が設定されていない場合は ~/.rlm-wiki

--style custom は、--style-prompt または --style-prompt-file と併用する場合にのみ使用してください。

質問
grok-wiki ask <source> "question" [--agent ID] [--model MODEL] [--reasoning LEVEL] [--mode fast|deep]
grok-wiki ask <source...> --question "question" [--workspace-goal compare|steal|understand|bridge|audit]

例：

grok-wiki ask expressjs/express "How does routing work?" --mode deep
grok-wiki ask ./api ./web --question "Compare auth flows" --workspace-goal compare
grok-wiki ask owner/repo-a owner/repo-b --question "What should we steal?" --workspace-goal steal

質問モード：

  • fast：対象を絞った調査と簡潔な回答
  • deep：より広範な調査と、確かな根拠に基づく回答

ワークスペースの目的：

  • compare
  • steal
  • understand
  • bridge
  • audit
保存済み Wiki の一覧表示
grok-wiki list

再生成する前に、既存のローカル Wiki レコードを探すには、これを使用します。

サーバー、ワーカー、サイドカー
grok-wiki serve --port 3141 --host 127.0.0.1
grok-wiki worker --once
grok-wiki sidecar --token TOKEN --port 0 --host 127.0.0.1 --stamp PATH

ローカルの Web／API ランタイムには serve を使用します。worker と sidecar は、Grok-Wiki のランタイムプロセスモデル、またはローカル CLI アダプターのデバッグがタスクに明示的に含まれる場合にのみ使用してください。

エージェント向けガイダンス

  • grok-wiki は、Wiki の生成と質問に限り、ローカル CLI として扱ってください。OPENAI_API_KEY、ANTHROPIC_API_KEY、GEMINI_API_KEY などのプロバイダー API キーを必須にしないでください。
  • BYOC/BYOK の動作を維持してください。選択されたローカル CLI エージェントに、プロバイダーや認証の詳細を任せてください。
  • ユーザーがエージェントを選択した場合に限り、明示的な --agent を指定してください。それ以外の場合は、CLI の最初に利用可能なエージェントを使うデフォルト設定に従ってください。
  • 列挙型のフラグは推測せず、値を検証してください。エージェント ID、質問モード、ワークスペースの目標、スタイル、ページ数モード、言語には、既知の値を指定する必要があります。
  • ローカルリポジトリにはローカルパスを直接使用してください。GitHub のリモートを強制しないでください。
  • 複数リポジトリに関するタスクでは、各ソースを位置引数で渡し、質問には --question を使用してください。
  • --runtime rlm やクラウドプロバイダー向けランタイムフラグは使用しないでください。CLI がこれらのフローで受け付けるのは --runtime local-cli のみです。
  • サイドカーまたは選択したエージェントが利用できず、実行に失敗した場合は、grok-wiki agents --rescan を実行し、セットアップ時のヒントを伝えてください。
  • CLI 自体のソースコードを変更する場合は、少なくとも次を実行してください。
bun test src/cli.test.ts
bunx tsc --noEmit
git diff --check

ジェネレーター、質問、サイドカー、またはストリーミングの動作を変更する場合は、変更した箇所に関連するテストも実行し、スコープ付きのストリーミング描画の契約を維持してください。

コメント

Markdown 対応