IBM Cloud CLI Developer Tools (ibmcloud dev) コマンド

IBM Cloud® コマンドラインインターフェイスには、 Developer Tools (ibmcloud dev) コマンドがあり、クラシックパイプライン、Tektonパイプライン、ツールチェーンを管理できます。

ヘルプ

アクションも引数も渡されない場合、または help アクションが指定された場合、デフォルトで、このコマンドは一般的なヘルプ・テキストを表示します。 表示される一般ヘルプには、基本の引数の説明と、使用可能なアクションのリストが含まれます。

以下のコマンドを実行して、一般的なヘルプ情報を表示します。

ibmcloud dev help

pipeline-get

クラシック・パイプラインの詳細を表示します。

ibmcloud dev pipeline-get [PIPELINE_ID] [--output JSON]

pipeline-get コマンド・パラメーター

json

  • パイプラインの詳細を JSON 形式で出力するために使用するパラメーター。
  • 使用方法：ibmcloud dev pipeline-get [PIPELINE_ID] --output JSON

以下のパラメーターを pipeline-get コマンドに指定して使用するか、アプリの cli-config.yml ファイルを直接更新することで使用できます。

コマンド・ラインで入力されたコマンド・パラメーターは、cli-config.yml 構成よりも優先されます。

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev pipeline-get [PIPELINE_ID] --trace

pipeline-run

クラシック・パイプラインを実行します。

ibmcloud dev pipeline-run [PIPELINE_ID] [--stage-id stageID] [--output JSON]

pipeline-run コマンド・パラメーター

以下のパラメーターを pipeline-run コマンドに指定して使用するか、アプリの cli-config.yml ファイルを直接更新することで使用できます。

コマンド・ラインで入力されたコマンド・パラメーターは、cli-config.yml 構成よりも優先されます。

stage-id

  • 実行するパイプラインのステージを選択するためにオプションで使用するパラメーター。
  • 使用方法：ibmcloud dev pipeline-run [PIPELINE_ID] --stage-id [stageID]

json

  • パイプラインの呼び出しの詳細を JSON 形式で出力するために使用するパラメーター。
  • 使用方法：ibmcloud dev pipeline-run [PIPELINE_ID] --output JSON

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev pipeline-run [PIPELINE_ID] --trace

pipeline-log

pipeline-log コマンドを使用すると、最近のクラシック・パイプライン・ログを表示できます。

  • パイプライン ID を引数として指定すると、そのパイプラインのすべてのステージのすべてのジョブのすべてのログが出力されます。
  • ステージ ID のフラグを指定すると、パイプライン中のそのステージを条件としてログがフィルタリングされます。
  • ステージ ID に加えてジョブ ID を指定すると、特定のステージの特定のジョブのログのみにフィルタリングされます。
  • ステージ ID、ジョブ ID に加えてジョブ実行 ID を指定すると、指定したジョブ実行 ID と一致するすべてのログが検索されます。

使用方法：

ibmcloud dev pipeline-log [PIPELINE_ID] [--stage-id stageID] [--job-id jobID] [--job-exec-id jobExecutionID]

pipeline-log コマンド・パラメーター

以下のパラメーターを pipeline-log コマンドに指定して使用するか、アプリの cli-config.yml ファイルを直接更新することで使用できます。

コマンド・ラインで入力されたコマンド・パラメーターは、cli-config.yml 構成よりも優先されます。

job-id

  • ジョブ ID でログをフィルタリングするために使用するパラメーター。
  • stage-id フラグが必要です。
  • 使用方法：ibmcloud dev pipeline-log [PIPELINE_ID] --stage-id [stageID] --job-id [jobID]

job-exec-id

  • ジョブ実行 ID でログをフィルタリングするために使用するパラメーター。
  • stage-id フラグが必要です。
  • job-id フラグが必要です。
  • 使用方法：ibmcloud dev pipeline-log [PIPELINE_ID] --stage-id [stageID] --job-id [jobID] --job-exec-id [jobExecutionID]

stage-id

  • ステージ ID でログをフィルタリングするために使用するパラメーター。
  • 使用方法：ibmcloud dev pipeline-log [PIPELINE_ID] --stage-id [stageID]

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev pipeline-log [PIPELINE_ID] --trace

pipeline-open

pipeline-open コマンドを使用すると、クラシック・パイプラインの URL を表示できます。 pipeline-open コマンドにより、ユーザーのデフォルト・ブラウザーでも URL が開かれます。

ibmcloud dev pipeline-open [PIPELINE_ID]

pipeline-open コマンド・パラメーター

以下のパラメーターを pipeline-open コマンドに指定して使用するか、アプリの cli-config.yml ファイルを直接更新することで使用できます。

コマンド・ラインで入力されたコマンド・パラメーターは、cli-config.yml 構成よりも優先されます。

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev pipeline-open [PIPELINE_ID] --trace

tekton-info

Tekton パイプラインの詳細を表示します。

ibmcloud dev tekton-info [PIPELINE_ID] [--verbose][--output JSON]

tekton-info コマンド・パラメーター

以下のパラメーターを tekton-info コマンドで使用できます。

verbose

  • このパラメーターを使用して、パイプラインのすべての詳細を JSON 形式で指定します。
  • 使用方法：ibmcloud dev tekton-info [PIPELINE_ID] --verbose

json

  • パイプラインの詳細を JSON 形式で出力するために使用するパラメーター。
  • 使用方法：ibmcloud dev tekton-info [PIPELINE_ID] --output JSON

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev tekton-info [PIPELINE_ID] --trace

tekton-logs

tekton-logs コマンドを使用して、最近の Tekton パイプラインの実行ログを表示します。

  • パイプラインの実行 ID は必須の引数です。
  • タスク名を引数として指定した場合、そのタスクのログだけが取得されます。

使用方法：

ibmcloud dev tekton-logs [PIPELINE_ID] --run-id [pipelinerunID] [--task-name taskName] [--output JSON]

tekton-logs コマンド・パラメーター

以下のパラメーターを tekton-logs コマンドで使用できます。

run-id （必須）

  • ログ取得のために実行されるパイプラインを特定するパラメータ。
  • 使用方法：ibmcloud dev tekton-logs [PIPELINE_ID] --run-id [pipelinerunID]

task-name

  • パイプライン実行のタスク名でログをフィルタリングするために使用するパラメーター。
  • 使用方法：ibmcloud dev tekton-logs [PIPELINE_ID] --run-id [pipelinerunID] --task-name [taskName]

json

  • ログの詳細を JSON 形式で出力するために使用するパラメーター。
  • 使用方法：ibmcloud dev tekton-logs [PIPELINE_ID] --run-id [pipelinerunID] --output JSON

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev tekton-logs [PIPELINE_ID] --run-id [pipelinerunID] --trace

テクトンパイプラインキャンセル

進行中の Tekton パイプラインの実行をキャンセルします。

ibmcloud dev tekton-pipeline-cancel [PIPELINE_ID] --run-id [pipelinerunID] [--trace]`

tekton-pipeline-cancel コマンド・パラメーター

以下のパラメーターを tekton-pipeline-cancel コマンドで使用できます。

run-id （必須）

  • キャンセルするパイプラインランを特定するパラメータ。
  • 使用方法：ibmcloud dev tekton-pipeline-cancel [PIPELINE_ID] --run-id [pipelinerunID]

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev tekton-pipeline-cancel [PIPELINE_ID] --run-id [pipelinerunID] --trace

tekton-pipelinerun

Tekton パイプライン実行の詳細を表示するか、ls パラメーターを使用してそのパイプラインに対するすべてのパイプライン実行をリストします。

使用方法：

ibmcloud dev tekton-pipelinerun [PIPELINE_ID] --run-id [pipelinerunID] [--output JSON]
ibmcloud dev tekton-pipelinerun ls [PIPELINE_ID]

tekton-pipelinerun コマンド・パラメーター

以下のパラメーターを tekton-pipelinerun コマンドで使用できます。

run-id （必須）

  • 取得するパイプライン実行を識別するためのパラメーター。
  • 使用方法：ibmcloud dev tekton-pipelinerun [PIPELINE_ID] --run-id [pipelinerunID]

json

  • パイプライン実行の詳細を JSON 形式で出力するために使用するパラメーター。
  • 使用方法：ibmcloud dev tekton-pipelinerun [PIPELINE_ID] --run-id [pipelinerunID] --output JSON

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev tekton-pipelinerun [PIPELINE_ID] --run-id [pipelinerunID] --trace

tekton-pipelineruns

Tekton パイプラインのパイプライン実行のリストを表示します。

使用方法：

ibmcloud dev tekton-pipelineruns [PIPELINE_ID] [--output JSON]

tekton-pipelineruns コマンド・パラメーター

以下のパラメーターを tekton-pipelineruns コマンドで使用できます。

json

  • パイプライン実行を JSON 形式で出力するために使用するパラメーター。
  • 使用方法：ibmcloud dev tekton-pipelineruns [PIPELINE_ID] --output JSON

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev tekton-pipelineruns [PIPELINE_ID] --trace

tekton-trigger

Tekton パイプラインを実行します。

使用方法：

ibmcloud dev tekton-trigger PIPELINE_ID --trigger-name triggerName [--description "a description"] [--trigger-properties propertiesJSON] [--secure-trigger-properties securePropertiesJSON] [--trigger-headers headerJSON] [--trigger-body bodyJSON] [--output JSON]

tekton-trigger コマンド・パラメーター

以下のパラメーターを tekton-trigger コマンドで使用できます。

trigger-name （必須）

  • このパラメーターを使用して、実行するトリガーを指定します。
  • 使用方法：ibmcloud dev tekton-trigger PIPELINE_ID --trigger-name triggerName

description (オプション)

  • オプション。 このパラメータを使用して、作成された Tekton pipelineRun の説明を指定します。
  • 使用方法：ibmcloud dev tekton-trigger PIPELINE_ID --trigger-name triggerName --description "My description"

trigger-properties (オプション)

  • オプション。 このパラメーターを使用して、定義されたトリガー・プロパティーをオーバーライドまたは追加します。 例えば、'{"pipeline-debug":"true"}'です。
  • 使用方法：ibmcloud dev tekton-trigger PIPELINE_ID --trigger-name triggerName --trigger-properties propertiesJSON

secure-trigger-properties (オプション)

  • オプション。 このパラメーターを使用して、後の出力でドットまたはアスタリスクの後ろに値を隠蔽する必要がある定義済みトリガー・プロパティーをオーバーライドまたは追加します。 例: '{"deployer-api-key":"s0mEThING_v3Ry_s3CReT"}'
  • 使用方法：ibmcloud dev tekton-trigger PIPELINE_ID --trigger-name triggerName --secure-trigger-properties securePropertiesJSON

trigger-headers (オプション)

  • オプション。 このパラメータを使用して、Tekton pipelineRun の triggerBinding で使用されるヘッダを指定します。 例えば、'{"source":"cli","flag":"enable"}'です。
  • 使用方法：ibmcloud dev tekton-trigger PIPELINE_ID --trigger-name triggerName --trigger-headers headerJSON

trigger-body (オプション)

  • オプション。 このパラメーターを使用して、Tekton pipelineRun の triggerBinding で使用される本体を指定します。 例えば、'{"message":"hello world","flag":"enable"}'です。
  • 使用方法：ibmcloud dev tekton-trigger PIPELINE_ID --trigger-name triggerName --trigger-body bodyJSON

json

  • このパラメーターを使用して、トリガー結果を JSON 形式で出力します。
  • 使用方法：ibmcloud dev tekton-trigger PIPELINE_ID --trigger-name triggerName --output JSON

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev tekton-trigger PIPELINE_ID --trigger-name triggerName --trace

toolchain-delete

ツールチェーンを削除します。 ツールチェーン名を指定しなかった場合は、リストから選択できます。 現在ターゲットにしているリソース・グループとリージョンに応じたツールチェーンがリストされます。

ターゲットにしているリソース・グループは IBMCLOUD API Key で確認できます。 詳しくは、ターゲットのアカウント、リージョン、リソース・グループの設定または表示を参照してください。

ibmcloud dev toolchain-delete [toolchainName] [--force,-f]

toolchain-delete コマンド・パラメーター

以下のパラメーターを toolchain-delete コマンドに指定して使用するか、アプリの cli-config.yml ファイルを直接更新することで使用できます。

コマンド・ラインで入力されたコマンド・パラメーターは、cli-config.yml 構成よりも優先されます。

force

  • ツールチェーンの削除の確認を求めるプロンプトをスキップするために使用するパラメーター。
  • 使用方法：ibmcloud dev toolchain-delete [toolchainName] --force

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev toolchain-delete [toolchainName] --trace

toolchain-get

ツールチェーンの詳細を表示します。 ツールチェーン名を指定しなかった場合は、リストから選択できます。

IBMCLOUD API Key のターゲット・リソース・グループを使用します。 詳しくは、ターゲットのアカウント、リージョン、リソース・グループの設定または表示を参照してください。

ibmcloud dev toolchain-get [toolchainName] [--output JSON]

toolchain-get コマンド・パラメーター

以下のパラメーターを toolchain-get コマンドに指定して使用するか、アプリの cli-config.yml ファイルを直接更新することで使用できます。

コマンド・ラインで入力されたコマンド・パラメーターは、cli-config.yml 構成よりも優先されます。

json

  • ツールチェーンの詳細を JSON 形式で出力するために使用するパラメーター。
  • 使用方法：ibmcloud dev toolchain-get [toolchainName] --output JSON

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev toolchain-get [toolchainName] --trace

toolchain-open

toolchain-open コマンドを使用すると、ツールチェーンの URL を表示できます。 toolchain-open コマンドにより、ユーザーのデフォルト・ブラウザーでも URL が開かれます。 ツールチェーンを指定しなかった場合は、選択できるようにツールチェーンのリストが表示されます。

ibmcloud dev toolchain-open [toolchainName]

toolchain-open コマンド・パラメーター

以下のパラメーターを toolchain-open コマンドに指定して使用するか、アプリの cli-config.yml ファイルを直接更新することで使用できます。

コマンド・ラインで入力されたコマンド・パラメーターは、cli-config.yml 構成よりも優先されます。

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev toolchain-open [toolchainName] --trace

ツールチェーン

現在のリソース・グループにあるツールチェーンのリストを表示します。

IBMCLOUD API Key のターゲット・リソース・グループを使用します。 詳しくは、ターゲットのアカウント、リージョン、リソース・グループの設定または表示を参照してください。

ibmcloud dev toolchains [--output JSON]

toolchains コマンド・パラメーター

以下のパラメーターを toolchains コマンドに指定して使用するか、アプリの cli-config.yml ファイルを直接更新することで使用できます。

コマンド・ラインで入力されたコマンド・パラメーターは、cli-config.yml 構成よりも優先されます。

json

  • ツールチェーンを JSON 形式で出力するために使用するパラメーター。
  • 使用方法：ibmcloud dev toolchains --output JSON

trace

  • このパラメーターを使用して、詳細出力を提供します。
  • 使用方法：ibmcloud dev toolchains --trace