ホワイトボックス診断(都度)
概要
Takumi ホワイトボックス診断機能は、GitHub リポジトリ連携またはファイルアップロードでソースコードを受け取り、Takumi が診断を行い、結果を Web 上でレポートとして出力する機能です。
Shisho Cloud byGMO の Web 画面から利用できます。ホワイトボックス診断(定期)とは異なり、Slack 連携は不要です。
診断の開始方法
サイドバーの「診断」をクリックすると表示される画面において、画面右上の「診断を作成」ボタンを押すと診断が開始できます。

基本設定
設定画面の主な項目は以下のとおりです。
- 「診断名」:この診断を識別するための名前を入力する
- 「レポート言語」:診断レポートの言語を選択する(英語または日本語)
- 「診断対象」:「ソースコード」を選択する
診断タイプ
診断開始時に、以下の 2 つのモードから選択できます。
- 「全体を診断」モード:対象ソースコードの機能列挙・初回スキャンを一気通貫で実行し、完了後に「診断再開待ち」状態で停止する。以降の手順は 診断結果の確認と追加スキャン を確認する
- 「一部だけ診断」モード:最初に診断対象のコードベースから「機能」を列挙し、完了すると列挙された機能が表示される。表示された機能から診断対象や診断の優先度を決定して、診断を開始する
クレジット上限
クレジット上限は、機能列挙およびスキャンのそれぞれについて設定することが可 能です(「一部だけ診断」モードの場合は機能列挙のみ)。Takumi は指定されたクレジット上限の範囲内で機能列挙およびスキャンを実施します。
ソースコード設定
以下のいずれかの方法でソースコードを提供できます。
GitHub リポジトリ
GitHub リポジトリを1つ以上指定できます。「リポジトリを追加」ボタンから診断対象のリポジトリを追加します。
対象リポジトリのブランチを指定することができます。指定しない場合は、リポジトリのデフォルトブランチが診断対象となります。
ファイルアップロード
ソースコードのアーカイブファイルを直接アップロードできます。GitHub 連携が利用できない場合や、ローカルのコードベースを診断する場合に便利です。
- 対応フォーマット:
.zipまたは.tar.gz - 「ファイルをアップロード」ボタンからアーカイブを選択してアップロードする
- 展開後のルートディレクトリが表示され、後述のファイルスコープの指定で使用される
ファイルスコープ
診断対象に含めるファイルパスと除外するファイルパスを指定できます。すべてのファイルパスには glob パターン(例:src/auth/**、backend/services/**)を使用できます。スコープを空にした場合、コードベース全体が診断対象となります。
診断範囲
- 「対象」:対象となるリポジトリまたはアップロードしたファイルを選択する
- 「機能タイプ」(オプション):機能のカテゴリを指定する(例:
authentication、payments、api) - 「ファイルパス」:診断対象に含めるファイルパスを指定する
診断対象として指定された場合でも、Takumi の判断によりファイルパスが除外される場合があります。
除外設定
- 「対象」:対象となるリポジトリまたはアップロードしたファイルを選択する
- 「理由」(オプション):除外する理由を記録する(例:「テストコード」「自動生成ファイル」)
- 「ファイルパス」:除外するファイルパスを指定する