メインコンテンツまでスキップ

生成内容を事前確認するには

このページでは、annai(ソースコードからユーザー向けマニュアルを自動生成するツール)でファイルを書き出さずに、生成されるページの一覧だけを確認します。

手順

  1. ターミナル(コマンドを入力する画面)を開き、annai.config.json があるプロジェクトのフォルダへ移動します。

  2. 以下のコマンドを入力し、キーボードの Enter(実行)キーを押します。

    annai gen --dry-run
  3. 処理が完了するまで待ちます。annai がソースコードの解析とページの生成を行いますが、ファイルの書き出しだけをスキップします。

  4. ターミナルに [dry-run] と表示されたファイル一覧を確認します。これが実際に生成されるページの一覧です。問題がなければ --dry-run を外して annai gen を実行します。

ここまでの手順が完了すると、マニュアル生成の結果を事前に把握できた状態になります。

警告

dry-run(事前確認モード)でもソースコードの解析やページの生成は実行されるため、処理時間は通常の生成とほぼ同じです。 「認証が切れています」というメッセージが表示された場合は、claude login を実行して再認証した後、再度コマンドを実行します。

関連ページ