このページは英語版ドキュメントの翻訳です。コマンド、識別子、例はそのままです。ランタイム 7.24.4 · SDK 2.6.7。 英語版
AX Wiki 概要
状態: 有効 範囲: 現行状態 最終確認: 2026-10-03 担当: AX Code ランタイム
AX Wiki は AX Code のネイティブなリポジトリ wiki コンパイラです。追跡されたソース、設定、テスト、ワークフロー、既存ドキュメントを、.ax-wiki/ 配下の小さなソース裏付け Markdown 知識ベースへ変えます。AX Code と同じプロバイダー設定とモデルルーティングを使います。別の実行ファイルや資格情報ストアはありません。
ax-code wiki viz は、コンパイルされたページと、それらが引用するファイルを描きます。その地図のスクリーンショットは Wiki 証拠の可視化 にあります。
どこに収まるか
| 必要 | 源 |
|---|---|
| アーキテクチャ、モジュールの責任、ワークフロー、設計意図 | .ax-wiki/。quickstart.md から始めます |
| 正確なシンボル、呼び出し元、呼び出し先、参照、リファクタの影響 | ax-code index、code_intelligence、および LSP |
| リポジトリのルール、コマンド、安全制約 | AGENTS.md |
| 個人の好みと耐久的な決定 | .ax-code/memory.json |
Wiki の散文はコンパイルされたナビゲーション層であり、構造上の証明ではありません。wiki がコードと食い違う場合はコードを信じ、ax-code wiki update を実行してください。
クイックスタート
AX Code プロバイダーに接続してから実行します。
ax-code wiki plan
ax-code wiki generate
ax-code wiki doctor
ax-code init --wiki は AGENTS.md を生成し、AX Wiki ポインタブロックを挿入し、1 つのワークフローで wiki をコンパイルします。モデル呼び出しなしでポインタを追加するには --wiki-only-agents を使います。
コマンド
| コマンド | 目的 |
|---|---|
ax-code wiki plan |
決定的なページ計画をプレビューします。モデル呼び出しはありません |
ax-code wiki generate |
計画されたすべてのページをコンパイルします |
ax-code wiki update |
ソースまたは計画の変更が影響するページだけを再生成します |
ax-code wiki status |
ディレクトリ、クイックスタート、マニフェスト、鮮度状態を表示します |
ax-code wiki doctor |
状態、検証、知識ルーティングの確認を実行します |
ax-code wiki lint |
メタデータ、引用、リンク、保護マーカー、ソース鮮度を検証します |
ax-code wiki ensure-agents |
AX-WIKI ブロックを AGENTS.md と既存の CLAUDE.md に追加または更新します |
ax-code wiki cards |
コンパクトな .ax-code/wiki-cards.md 索引を書きます |
ax-code wiki related <symbol> |
正確なフロントマターシンボル、または本文の言及でページを探します |
生成オプションには --model provider/model、--dir <relative>、--quiet、--skip-agents、--force が含まれます。保護セクションの外で手動編集された生成内容を置き換えるには、--force が意図的に必要です。
リポジトリディレクトリ
v7.22.2 から、既定の出力ディレクトリは .ax-wiki/ です。隠れた接頭辞は、AX Code が保守するリポジトリ知識を識別します。ファイルを Git 無視にはしません。この知識をコミットするか、/.ax-wiki/ をリポジトリの .gitignore に追加するかを選んでください。
別の相対ディレクトリを選ぶには、wiki.dir を ax-code.json または --dir docs/knowledge の中で使います。CLI フラグが優先されます。生成、状態、エージェントポインタ、バックグラウンド保守、可視化はすべてその選択を使います。コンパイラは、より古い ax-wiki/ ディレクトリを自動では検出、移動、マージしません。パッケージ名とジェネレーター名、ax-wiki.config.json と ax-wiki.instructions.md は変わりません。
生成される契約
AX Wiki は Markdown ページと .ax-wiki/.manifest.json を書きます。各ページのフロントマターには次が含まれます。
generated_by: ax-wiki- 簡潔な
summary - 証拠に裏付けられた生成から返された正確な
symbols - ページのコンパイルに使われた、リポジトリ相対の
sources
マニフェストは、決定的な計画ハッシュ、リポジトリのソースハッシュ、ページハッシュ、生成モデル、git リビジョン、生成時刻を保存します。ページは原子的に書かれます。マニフェストは最後に書かれ、完全なインメモリ候補が検証に合格したあとだけです。
ソース発見は、Git の追跡および無視されていないファイル一覧を好み、生成、ビルド、ベンダーのディレクトリと wiki 自身を除外し、バイナリまたは大きすぎるファイルを飛ばし、リポジトリ外のパスやシンボリックリンクを拒否します。
サブシステムナビゲーション
既定の計画は、クイックスタート、アーキテクチャ、開発のページを保ちます。1 ページのソース数または証拠バイト予算を超えるモジュールは、modules/core/src/session.md のような焦点を絞ったページも受けられます。これらのページは、モジュールの src、lib、または app ディレクトリ直下のサブディレクトリを扱い、サブシステムあたり少なくとも 3 つのコードファイル、モジュール内に対象となるサブシステムが 2 つ必要です。
サブシステムページには、その実装サブツリーと、モジュールの test または tests ディレクトリ配下の一致ファイルが含まれます。生成指示は、入口、ランタイムの流れ、境界、具体的な変更場所、関連テストを求めます。モジュールページは、順位の最も高いソースの直後にテストファイルを最大 2 つ置くため、テストは上限付きの証拠選択に参加できます。
既定の合計予算は、3 つの概要ページを含めて 12 ページのままです。モジュール概要とサブシステムページは、残りの枠をソース数で争います。サブシステムは親の概要のあとだけ含まれます。したがって、より大きいサブシステムは、より小さいパッケージページを押しのけられます。結果は ax-code wiki plan でプレビューしてください。maxPages を上げる(自動計画では最大 40)、または特定のサブシステムに保証された網羅が必要なときは明示的な pages を設定します。明示的な計画は権威のままで、自動のサブシステムページは受け取りません。
これはナビゲーションと証拠の焦点を改善します。生成された散文を検証せず、エージェントが wiki を読むことも保証しません。実装の詳細に頼る前に、引用を現在のソースまでたどってください。
エージェントが wiki を使う方法
エージェントは、最も安いものから最も具体的なものへ、3 つの方法で wiki に到達します。
- プロンプト索引。 健全な wiki があるとき、セッションプロンプトは短い
<repo_wiki>ブロックを運びます。wiki の場所、鮮度ラベル、ページあたり 1 行(パスと切り詰めた要約。既定の 12 ページで約 750 トークン)です。要約はどこを読むかの位置だけを示し、証明ではありません。 repo_wikiツール。 3 つの操作を持つ読み取り専用ツールです。index(ページごとの鮮度付きページカード)、read(1 ページとその引用ソース、どの引用ソースが変わったか、それらのソースに見つからないフロントマターシンボル)、related(シンボル、本文の言及、またはソースパスのページ)。完全およびコーディングのツールプロファイルで利用でき、read権限を使います。- 一般的なファイルツール。
read、glob、grepは.ax-wiki/に対しても依然として働きます。
プロンプトの鮮度はページごとに判断されます。ページが引用するすべてのソースがマニフェストハッシュと一致している間、そのページは新しいです。どのページも引用しない追加または編集されたファイルは、プロンプトラベルを fresh のままにし、wiki がまだそれを覆っていないという注を追加します。引用されたソースの変更はラベルを stale にし、プロンプトはエージェントに wiki をナビゲーションとしてだけ扱うよう求めます。ax-code wiki status と wiki lint は、より厳しいリポジトリ全体の判定を保ちます。追加、削除、編集された対象ファイルが 1 つでもあれば古いです。
wiki は決してソースを置き換えません。すべての read 結果は照合すべきファイルを列挙し、ページとコードが食い違う場合はコードが勝ちます。
増分更新と手動内容
wiki update は現在のソースハッシュをマニフェストと比較し、各ページのセレクターを通して変更を対応付けます。計画の変更は計画されたすべてのページを再生成します。そうでなければ無関係なページは触れられません。
生成された散文はコンパイラが所有します。耐久的なメンテナーのテキストは、保護ブロックの中に置いてください。
<!-- AX-WIKI:PROTECTED:START deployment-warning -->
Production migrations require an operator-approved maintenance window.
<!-- AX-WIKI:PROTECTED:END -->
保護された本文は再生成を生き延びます。--force が供給されない限り、AX Wiki は他の手動編集の上書きを拒否します。古くなった生成ページは、管理された内容が変わっておらず、保護セクションを含まないときだけ削除されます。
設定
連携はプロジェクトの ax-code.json で設定します。
{
"wiki": {
"enabled": true,
"auto": true,
"dir": ".ax-wiki",
"model": "openai/gpt-5-mini",
"autoInjectAgents": true,
"touchClaudeMd": true,
"maxPages": 12,
"generationConcurrency": 2,
"maxSourcesPerPage": 80,
"exclude": ["fixtures/**"]
}
}
include、exclude、maxSourceBytes、maxPageSourceBytes は、証拠の発見と予算を制御します。instructions はプロジェクト固有のコンパイラ案内を追加します。完全に厳選された計画では、pages 項目を path、title、purpose、selectors とともに設定します。明示的な計画は quickstart.md を含まなければなりません。
generationConcurrency は 1 または 2 を受け付けます。ネイティブクラウド生成は既定で同時ページ呼び出しが 2 つです。ローカルエンジンと CLI プロバイダーは既定で 1 つです。プロバイダーが重なるリクエストを待ち行列に入れるか制限するときは、1 に設定します。スケジューリングは既存のページ内容を無効にしません。この設定が供給されない限り、再利用可能なパッケージは直列のままです。
各モデルページは、180 秒の期限を共有する分類された試みを最大 2 回得ます。相対 Wiki リンクは、ページが受け入れられる前にページ計画と照合されます。壊れたリンクの応答は、残りの試みを使ってそのページを修復することがあります。最終検証と手動内容のガードは、公開前に依然として実行されます。
中断されたビルドは、検証済み結果を .ax-wiki/.page-cache/(または設定された Wiki ディレクトリ)に保持します。後のビルドは、現在のソース証拠、計画、ジェネレーター、モデル、以前の内容を確認したあとだけ、一致する結果を再利用します。最初の生成は、完全な候補が検証に合格するまで未公開のままです。成功した公開は、消費されたステージング項目を削除します。その後の明示的な wiki generate は、依然としてすべてのページを再生成します。キャッシュ項目は上限があり、権限でゲートされます。破損またはアクセスできない項目は無視されます。
.build-report.json は、モデル生成およびキャッシュされたページを、実際に公開された written ページから区別します。任意の pages 配列は、各ページの試み、所要時間、プロンプトとソースのバイトサイズ、プロバイダーが供給した場合の正確なトークン使用量を記録します。失敗または取り消されたビルドは、公開ページを報告しません。
コンパイラ案内は ax-wiki.instructions.md に、中核エンジン設定は ax-wiki.config.json にも置けます。両方が供給されるところでは、明示的な AX Code ランタイム設定が中核設定を上書きします。
既定の対話的保守
AX Code TUI でプロジェクトを開くと、既定でバックグラウンドの Wiki 保守が有効になります。プロジェクトが 30 秒アイドルになると、欠けた成果物が生成され、古い成果物が増分更新されます。忙しい、または再試行中のセッション、待ち行列の作業、空でない下書きは優先され、バックグラウンド生成を取り消します。現在のエージェントの読み書き権限が適用されます。読み取り専用エージェントは生成しません。このバックグラウンドワークフローはエージェント指示ファイルを書き換えません。
バックグラウンド保守を無効にするには "wiki": { "auto": false } を、コンパイルとプロンプト注入を無効にするには enabled: false を使います。auto は既定で true であり、設定は書きません。設定された Wiki モデル、または AX Code の既定モデルを使い、ジョブ期限は 10 分、バックオフ付きの自動試行は最大 3 回です。明示的なグラフ要求、またはソースや設定の変更は、別の試みを許します。ヘッドレス実行と CI は対話スケジューラを有効にしません。Git 以外のディレクトリは明示的な要求を必要とします。Git プロジェクトでは、Wiki の生成と消費は最も近い worktree ルートを使うため、パッケージ内で AX Code を開いても別のパッケージ Wiki は作られません。
セッションサイドバーと /wiki-viz は、ローカルの進捗ページをすぐに開き、保守を要求します。スナップショットの準備ができると、そのページは記録された Wiki ページとソースの関係を示します。Wiki の可視化 を参照してください。
エージェントルーティング
健全な wiki があり、wiki.enabled が false でないとき、セッションプロンプトはコンパクトな <repo_wiki> プロトコルを受け取ります。エージェントに、クイックスタートから始め、関連ページだけを読み、重要な主張は引用ファイルを通して検証し、構造上の質問にはグラフと LSP のツールを使うよう伝えます。
healthy は、wiki ディレクトリ、索引、マニフェストの存在を説明します。別の freshness フィールドは fresh、stale、または unknown です。状態とセッションルーティングは、有効な包含と除外とサイズ設定を使って現在のソースハッシュを比較するため、未コミットの編集、追加、削除が検出されます。確認はキャッシュされた新しい判定を再利用しません。上限付きの読み取り並行で対象ソースを走査します。欠けた、または無効な wiki はソース走査を避けます。鮮度は時点のソース確認であり、すべての生成された主張やページの検証ではありません。成果物の検証には lint を使ってください。
古い、または未検証の wiki はナビゲーションのために利用可能なままで、実装の主張に頼る前に現在の元ソースを検証する明示的な指示が付きます。検証エラーは unknown を作ります。wiki ディレクトリが存在しないとき、wiki status は終了コード 0 です(欠けた wiki がその報告です)。wiki があるとき、wiki が不健全、または鮮度が fresh でない場合は失敗して終了します。
Wiki の証拠は上限があります。選ばれた各ソースは、ページ予算の中で最初の 32,000 バイトまでを寄与し、ジェネレーターのために切り詰めが印付けされます。GraphContext は選ばれた断片を追加できますが、各断片は 80 行に限られます。これらのナビゲーション補助は、変更されたすべての関数や必要なガードの保持を保証しません。範囲を絞ったレビューには、必要な元コードを別に提供してください。
管理された <!-- AX-WIKI:START --> ブロックは AGENTS.md の中にあり、wiki 内容をリポジトリ指示へコピーせずに、同じルーティングポリシーを運びます。
CI
プロバイダー認証されたジョブで ax-code wiki update のあとに ax-code wiki lint を実行し、そのあとドキュメント PR を開きます。examples/ax-wiki-update.yml を参照してください。生成された wiki の変更は他のドキュメントと同様に扱ってください。ソース引用をレビューし、モデル出力の自動マージは避けてください。
トラブルシューティング
| 症状 | 行動 |
|---|---|
| モデルがない、または認証エラー | AX Code プロバイダーを接続または設定するか、--model provider/model を渡します |
manually modified generated pages |
耐久テキストを保護マーカーへ移すか、見直して --force で再実行します |
| Wiki が古い | ax-code wiki update を実行し、そのあと ax-code wiki lint を実行します |
| ページまたは引用が欠けている、壊れている | ax-code wiki generate を実行します。設定されていればカスタムページセレクターを調べます |
| アーキテクチャの回答に正確な参照が必要 | code_intelligence または LSP を使います。wiki は概念的なナビゲーションです |