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

クイックスタート

このページでは、annai（ソースコードからユーザー向けマニュアルを自動生成するツール）の初期設定を行い、最初のマニュアル生成を体験します。

手順​

  1. ターミナル（コマンドを入力する画面）を開き、マニュアルを作成したいプロジェクト（開発中のアプリケーションのフォルダ）へ移動します。your-project の部分は、実際のフォルダ名に置き換えます。

    cd your-project

  2. 初期設定コマンドを入力し、キーボードの Enter（実行）キーを押します。設定ファイルとワークフローファイルが自動で作成されます。

    annai init

  3. マニュアル生成コマンドを入力し、Enter キーを押します。annai がソースコードを解析し、マニュアル一式を生成します。

    annai gen

  4. 生成が完了したら、出力先フォルダに移動してマニュアルをブラウザで確認します。

    cd user-manual
    npm install
    npm start

ここまでの手順が完了すると、annai の設定ファイルが作成され、最初のマニュアルが生成された状態になります。

警告

annai を使うには、Node.js 18 以上と Claude CLI（コマンドラインツール）が必要です。 「claude CLI が見つかりません」というメッセージが表示された場合は、Claude CLI をインストールし、claude login で認証を完了してから再度実行します。

関連ページ​