コマンド構文の概要

すべての OLP CLI コマンドの構造は次のとおりです。

olp <command group> <command> <arguments> [required and/or optional parameters]

例 :

olp pipeline create pipeline-name --scope <YOUR_PROJECT_HRN>

OLP CLI にパラメータを渡しています

OLP CLI では、コマンドパラメータを渡すために使用できる文字のセットがサポートされています。

1. スペース=区切り文字と equal() 区切り文字。

   デフォルトでは、コマンドパラメータはスペースで区切られていますが、次=の例のように、 equal() 区切り文字を使用することもできます。

    olp catalog list --profile <your_profile_name>
   

   or

    olp catalog list --profile=<your_profile_name>
   

2. チルダプレフィックス ()~。

   チルダプレフィックス ()~を使用して Linux 環境でユーザーのホームディレクトリを指定する場合は、 = 区切り文字とチルダを組み合わせて使用できないため、スペースを使用する必要があります。

    olp catalog layer stream put hrn:here:data::org:catalog1 stream-layer1 --input ~/path/to/dir
   

3. パイプ (|) およびダッシュ (-) の文字。

   pipe()|文字を使用すると、 1 つのコマンドの出力を取得して、別のコマンドの入力として送信できます。 dash()-文字を使用すると、その出力をキャプチャして、他のコマンドの特定のパラメータに渡すことができます。

   次の例で catalog show は、このコマンドは hrn:here:data::org:catalog-1 カタログの設定を JSON 形式で返します。 この catalog update コマンドを使用すると、カタログの概要、名前、説明、およびレイヤー設定を含む hrn:here:data::org:catalog-2 カタログの設定を更新するために、 hrn:here:data::org:catalog-1 設定が（--config - から）取得されます。

    olp catalog show hrn:here:data::org:catalog-1 --json | olp catalog update hrn:here:data::org:catalog-2 --config -
   

出力形式オプション

OLP CLI のデフォルト出力は、人間が読みやすいように最適化されています。 このような終了コードが使用されます。

• 0: コマンドが成功すると返されます。
• 1: 無効なパラメータでコマンドが実行されたときに返されます。
• 2: 無効な設定ファイルが使用された場合に返されます。
• 3: コマンドが失敗したときに返されます。
• 4: 存在しないリソース ( 主にカタログ ) でコマンドが実行されたときに返されます。

すべてのコマンドに --quiet は、追加情報なしで必須値に出力を削減できるフラグがあります。

コンソールに出力を表示するコマンドは --json 、フラグをサポートしています。 このフラグは、コマンドに応じて、 JSON 形式の出力に追加情報を表示します。 スクリプトを使用して JSON 出力を解析することもできます。

または OLP_OUTPUT 、環境変数を json またはに設定し quiet て、出力形式を選択できます。 ただし、フラグの優先度は環境変数よりも高くなります。

例 :

export OLP_OUTPUT=json

set OLP_OUTPUT=json

以前に設定した出力形式を無効にするには、 OLP_OUTPUT を verbose に設定します。これはデフォルト値です。