コンテンツにスキップ
Documentation

AIエージェントをヘッドレスで、かつCI内で実行します

ヘッドレスモードでは、1つのプロンプトを完了まで実行し、解答を出力して終了します。 プロンプトは一切表示されないため、実行するすべての処理は事前に決定しておく必要があります。

Terminal window
champrep ai -p "list the Go files here and count them"

標準入力からプロンプトを読み込むには、 -p -:

Terminal window
git diff | champrep ai -p -

デフォルトでは読み取り専用です

Section titled “デフォルトでは読み取り専用です”

追加のフラグを指定しない場合、ヘッドレス実行は読み取り専用となります。エージェントはワークスペースの読み取りや検索は 可能ですが、ファイルの編集やコマンドの実行はできません。権限の確認プロンプトが必要な 操作はすべて拒否され、その理由がモデルに通知されます。

以下のいずれかのフラグを使用すると、さらに多くの設定が可能になります:

フラグ適用
--allowed-tools RULESこの実行に限り、特定のルールを事前承認します。ルールに該当しない呼び出しは拒否されます。
--permission-mode accept-editsワークスペース内でのファイル編集を許可します。コマンドには引き続き許可ルールが必要です。
Terminal window
champrep ai -p "fix the failing test" \
--allowed-tools "local_edit_file(src/**),local_bash(go test*)"

ルールには、 許可ルールと拒否ルール。ルールは コンマまたはスペースで区切るか、フラグを繰り返してください。いずれかのフラグを使用する場合、 ユーザー設定ファイル内のルールも適用され、プロジェクト設定ファイルの拒否ルールは 常に適用されます。プロジェクト設定ファイルおよび defaultMode から 設定ファイルに記述された許可ルールは、ヘッドレス実行では使用されません。

ヘッドレスモードでは、サービスCHAMPREP内のデータを変更するアクションは 決して承認されません。それらは保留状態となり、実行時にアクション ID が出力されるため、 WebCHAMPREP アプリで承認または却下することができます。

フラグ適用
--output textデフォルトです。回答は標準出力に、ツールの動作は標準エラーに出力されます。
--output jsonNDJSONイベントを標準出力にストリーム出力します。 --json は、 --output は、特に定められていません。
--max-turns NN回のモデル実行後に停止します。制限に達すると、エラーとともに実行が終了します。
--model NAMEauto (デフォルト)、プラットフォームのモデル ID、または登録済みのモデルの名前。
--add-dir PATHワークスペースに別のディレクトリを追加します。繰り返し実行可能です。
--verboseまた、テキスト出力にステータス行も表示します。

以下のように --output json、各イベントは1行につき1つのJSONオブジェクトで構成されます。イベントには、 ストリーミングされた回答テキスト、ツールCHAMPREP呼び出しとその結果、ローカルツールイベント (local_tool_start, local_tool_result, local_resume)、および承認です。 最後の行は常に以下のいずれかになります:

{"type":"local_result","text":"There are 42 Go files.","conversation_id":"CONVERSATION_ID","suspensions":1,"model":"MODEL_ID","input_tokens":1234,"output_tokens":56}
{"type":"local_error","code":"ERROR_CODE","message":"Explanation of the failure"}

結果については最後の行を解析し、認識できない他のイベントタイプは 情報として扱います。

実行が成功すると、以下のメッセージが表示されて終了します。 0。失敗時は標準の CLI 終了コード、例えば 3 サインイン情報が 欠落しているか無効な場合、および 5 制限に達した場合の動作について。拒否された場合は、 標準エラー出力にヒントが表示されます。例:エージェントが含まれていないプランや、 待機秒数が含まれた分単位の制限などです。 Ctrl+C 実行を 停止します。

  1. 以下の内容を含むキーを作成します。 ai:agent スコープに加え、その他の スコープ champrep ジョブが実行するコマンドです。 ai:agent は、 名前で選択する必要があります。スコープが広範なだけでは、ローカルツールの使用は許可されません。

    Terminal window
    champrep keys create --name "ci-review" --scope ai:agent
  2. これを、マスクされ保護された CI シークレットとして、名前を CHAMPREP_TOKEN。これを直接CLI 使用し、キーチェーンは必要ありません。

  3. ジョブに必要な権限のみを付与してエージェントを実行してください。

ai-review:
script:
- champrep ai -p "review the changes in this merge request and list problems by severity" --output json --max-turns 20 > review.ndjson
- tail -n 1 review.ndjson

エージェントが実行するコマンドには、決して CHAMPREP_TOKEN またはその他の CHAMPREP_* 変数。ジョブの状態をランナーのホーム ディレクトリから分離するには、次のように設定してください。 CHAMPREP_CONFIG_DIR 一時ディレクトリに保存されます。

詳細については API 自動化CLI用のキー ローテーションおよびレビューについては、 プランと利用制限 CIの実行が利用制限にどのように 算入されるかについては、こちらをご覧ください。