リポジトリ Wiki の生成

RepoWiki は qoder wiki コマンドを使用してコードリポジトリを解析し、構造化された Wiki ドキュメントを生成します。

前提条件

サインインと認証が完了していること。qoder でサインインするか、QODER_PERSONAL_ACCESS_TOKEN を設定できます。詳細はサインインと認証を参照してください。
使用中のマシンから Qoder サービスにアクセスできること。初回実行時には Wiki コンポーネントの準備が必要であり、Wiki の生成にもネットワーク接続が必要です。

クイックスタート

対象リポジトリのルートディレクトリで以下を実行します。

qoder wiki

初回実行時、Qoder CLI は必要なコンポーネントを自動的に準備してから Wiki の生成を開始します。以降の実行では、公式にサポートされているバージョンを確認し、必要に応じてコンポーネントを自動更新します。個別のインストールや手動更新は必要ありません。

主なオプション

# 指定したリポジトリの Wiki を生成
qoder wiki --repo /path/to/repo

# 日本語と英語のドキュメントを生成
qoder wiki --language ja,en

# 指定したブランチの Wiki を生成
qoder wiki --branch develop

# 既存の Wiki データを再利用せず、最初から生成
qoder wiki --regenerate

オプション	説明
`--repo <path>`	対象リポジトリのパス。複数のリポジトリを処理する場合は複数回指定できます。
`--language <languages>`	`ja,en` のようにカンマで区切った出力言語。
`--branch <branch>`	処理する Git ブランチ。省略した場合は現在の `HEAD` ブランチを使用します。
`--regenerate`	既存の再利用可能な Wiki データを削除し、最初から生成します。
`--help`	現在の Wiki コンポーネントがサポートするオプションを表示します。

wiki より後のオプションは Wiki コンポーネントに渡されます。現在のバージョンがサポートする完全なオプションは、qoder wiki --help で確認できます。

作業ディレクトリの指定

デフォルトでは現在の作業ディレクトリを使用します。Qoder CLI レベルで別のワークスペースを指定する場合は、--cwd または --workspace を wiki より前に配置します。

qoder --cwd /path/to/repo wiki
qoder --workspace /path/to/repo wiki

wiki より後に --repo を指定して、1 つ以上の対象リポジトリを選択することもできます。

ネットワークとプロキシ

RepoWiki の実行時、Qoder CLI は一般的なプロキシおよび証明書の環境変数を引き渡します。これには HTTP_PROXY、HTTPS_PROXY、ALL_PROXY、NO_PROXY、NODE_EXTRA_CA_CERTS が含まれます。制限付きネットワーク環境でコンポーネントの準備、自動更新、認証、または Wiki の生成に失敗した場合は、プロキシと証明書の設定を確認してください。詳細はネットワーク、プロキシ、および VPC の問題を参照してください。

よくある質問

qoder wiki コマンドが見つからないのはなぜですか？ Qoder CLI を最新バージョンに更新し、ネットワーク接続を確認してから、qoder --help を再実行してください。 認証に失敗するのはなぜですか？ サインイン済みであること、または QODER_PERSONAL_ACCESS_TOKEN が正しく設定されていることを確認してください。詳細はサインインと認証の問題を参照してください。 コンポーネントの準備または自動更新に失敗するのはなぜですか？ ネットワーク、プロキシ、証明書の設定を確認してから、qoder wiki を再実行してください。使用可能なバージョンが既にインストールされている場合、バージョン確認が一時的に利用できなくても、そのバージョンを引き続き使用できます。 Wiki コンポーネントを更新するにはどうすればよいですか？ qoder wiki を実行してください。Qoder CLI が公式にサポートされているバージョンを自動的に確認して適用します。 既存の Wiki を最初から生成し直すにはどうすればよいですか？ qoder wiki --regenerate を実行してください。生成前に既存の再利用可能な Wiki データが削除されます。

次のステップ

サインインとトークン：サインインと認証。
ネットワークとプロキシの設定：ネットワーク、プロキシ、VPC。
コマンドライン起動パラメーター：CLI コマンドとパラメーター。