jk

Jenkins CLI

Jenkins の読み取りや変更には jk を使用します。構文が不明な場合は、jk --help またはサブコマンドのヘルプを確認してください。インストール状況やバージョンの確認は、コマンドが利用できない場合、または要求された機能に既知の最低バージョンがある場合に限って行ってください。

タスクの振り分け

リクエストに該当するルールだけを読みます。

• 認証と SSO：rules/auth.md
• 保存済みコントローラーとコンテキストの選択：rules/context.md
• ジョブ、フォルダー、設定、スキャン：rules/job.md
• 実行、パラメーター、再実行、ログ：rules/run.md
• アーティファクト：rules/artifact.md
• テストレポート：rules/test.md
• 認証情報：rules/cred.md
• ノード：rules/node.md
• キュー：rules/queue.md
• プラグイン：rules/plugin.md
• その他の管理コマンド：rules/other.md

正確なフラグや出力モードについては、サブコマンドに関する情報を references/commands.md で検索してください。

共通の運用ルール

• ユーザーが別のコントローラーを指定しない限り、アクティブなコンテキストを使用します。状態を変更する操作やセキュリティ上重要な操作を行う前に、対象のコンテキストを確認してください。
• 別のツールやスクリプトで結果を利用する場合は、構造化出力（--json または --yaml）を優先してください。
• パラメーター付きの実行を開始する前に、ジョブに宣言されているパラメーターを確認してください。名前や値を推測してはいけません。
• ジョブ設定、認証情報、ノード、プラグイン、キューのキャンセル、実行の削除は、状態を変更する操作として扱ってください。解決された対象を示し、ユーザーの承認に従ってください。
• Jenkins のトークンや認証情報のシークレットを、表示、保存、出力してはいけません。ブラウザーの SSO アクセストークンは Jenkins API トークンではありません。rules/auth.md に従ってください。
• ユーザーが明示的にそのリスクを選択しない限り、TLS 検証を弱めてはいけません。

よく使う読み取り操作

jk job ls
jk job view team/app
jk run ls team/app
jk run view team/app 128
jk log team/app 128 --follow
jk artifact ls team/app 128
jk test report team/app 128
jk queue ls

書き込みコマンドを作成する前に、該当するルールファイルを使用してください。

参考資料

• artifact — 実行アーティファクトを操作する
• auth — Jenkins インスタンスを認証する
• context — Jenkins コンテキストを管理する
• cred — Jenkins の認証情報を管理する
• job — Jenkins のジョブとパイプラインを管理する
• node — Jenkins ノードを確認・管理する
• plugin — Jenkins プラグインを確認・管理する
• queue — ビルドキューを確認する
• run — ジョブの実行を操作する
• test — テスト結果を確認する
• other — ログ、検索、バージョン