ドキュメントのスナップショット · CLI 7.30.1 · SDK 2.6.53。Desktop は各リリースに同梱されたランタイムを使用します。コマンドと例は英語原文のままです。 英語版
最初の AX Wiki を作成して使う
始める前に
AX Wiki は選択したリポジトリのソースから構成やワークフローのページを生成します。AX Code のウェブサイト文書とは別のリポジトリ知識です。先にプロバイダーを接続し、利用可能なモデルを選択します。選択した証拠は生成時にそのプロバイダーに送信され、料金が発生する場合があります。
プロジェクトフォルダーで実行します。Git プロジェクトではサブディレクトリから始めても最寄りのワークツリールートを使います。チェックアウトを確認し、生成物をバージョン管理するか決めます。
プレビューと生成
計画はモデルを呼び出さずに対象ファイルとページを表示します。生成前に確認します:
ax-code wiki plan
設定済みモデルで生成し、結果を検証してローカルリーダーを開きます:
ax-code wiki generate
ax-code wiki doctor
ax-code wiki viz --open
既定の出力は .ax-wiki/ で、.ax-wiki/quickstart.md から読み始めます。.ax-wiki/.manifest.json にソースとハッシュが記録されます。生成は AGENTS.md の Wiki 案内ブロックを更新することがあります。省略するには --skip-agents を使い、結果の差分を確認します。
読み方と質問の進め方
クイックスタートから引用ファイルをたどり、ワークフローがどこで実装されているか質問します。ビューアーはページ、引用、記録済みの関係を表示します。フォアグラウンドの CLI ビューアーは Ctrl+C で停止します。
Wiki で全体像をつかみ、現行コードとテストを確認します。正確なシンボル、呼び出し元、参照はコードインテリジェンスや LSP を使います。最新のページでも網羅性、正しさ、実行性能の証明にはなりません。
最新の状態に保つ
ソース変更後は影響するページを更新し、健全性を確認します:
ax-code wiki update
ax-code wiki status
ax-code wiki doctor
Wiki が存在しなくても status コマンドは正常終了する場合があります。存在と健全性の報告を確認してください。古い状態や異常は調査が必要です。CLI ビューアーは固定スナップショットなので更新後に開き直します。
現在の TUI では /wiki-viz がビューアーを開き、メンテナンスを要求します。対話操作時のアイドルメンテナンスは既定で有効ですが、前景作業が優先されます。ヘッドレス実行ではこのスケジューラーは有効になりません。
生成を制御する
次の任意設定をプロジェクトの ax-code.json に統合します。モデル ID は接続で利用できる値に置き換えます。この例は明示的コマンドを残してバックグラウンドメンテナンスを無効化します:
{
"wiki": {
"enabled": true,
"auto": false,
"model": "provider/model"
}
}
明示的な --model provider/model はその実行の Wiki モデルを上書きします。推論モデルの Wiki 生成には認識可能な低強度・無効化設定が必要です。このポリシーで拒否されたら別の対応モデルを選びます。
保守者のメモは保護ブロック内に書くと更新後も残ります:
<!-- AX-WIKI:PROTECTED:START project-note -->
Deployment requires maintainer review.
<!-- AX-WIKI:PROTECTED:END -->
問題から復旧する
-
モデルなし・認証エラー:プロバイダーの権限と Wiki モデルの設定を確認します。チャットで動くモデルがあっても、別の Wiki モデルが使える保証にはなりません。
-
タイムアウト・中断:
ax-code wiki doctorと.ax-wiki/.build-report.jsonを確認して原因を解消し、再試行します。検証済みの一時ページは再利用される場合があります。ビルド失敗は全ページの公開完了を意味しません。 -
手動編集の競合:メモを保護ブロックに移し、再試行前に変更を確認します。
--forceは保護ブロック外の編集を置換できるため、意図を確認して使用します。