​

グローバルオプション

グローバルオプションは、複数の Orchestor CLI データ操作コマンドで共通して使えます。対応するオプションはコマンドによって異なるため、--help で確認してください。ローカル設定コマンドのオプションは、各リファレンスページに記載しています。

--help で、コマンドの使い方と対応するオプションを表示します。

--workspace でリクエスト先のワークスペース ID を指定します。環境変数 ORCHESTOR_WORKSPACE_ID でも設定できます。

--json はコンパクトな JSON、--pretty はインデント付きの JSON を出力します。どちらも応答を envelope で包みます。

--format で出力形式を指定します。json、table、yaml、csv、raw に対応しています。省略すると人が読みやすい形式で表示します。

--field で応答から特定の項目を取り出します。ドット区切りのパスに対応し、--fields も同じ指定として使えます。

--raw は抽出した値を JSON の引用符や envelope なしで出力します。配列の値は 1 行ずつ出力するため、ほかのコマンドに渡せます。

--output で出力先のファイルパスを指定します。結果を標準出力の代わりにファイルへ保存します。

--no-pager で対話的なページ送りを無効にします。標準出力が端末でない場合は、既定で無効です。

--dry-run で送信予定のリクエストを確認します。API リクエストは送信しません。

--yes は破壊的な操作の確認プロンプトを省略します。アクセス権限を付与するオプションではありません。

--page-size はページ分割に対応した一覧コマンドで、1 ページの最大項目数を指定します。API の limit に対応します。

--page-all はページ分割に対応した一覧コマンドで、全ページを取得して 1 レコード 1 行の NDJSON で出力します。--json、--pretty など別の出力形式とは併用できません。

--stdin は作成・更新するリソースの JSON を標準入力から読み込みます。--from-stdin も同じ指定として使えます。

--timing でリクエストの所要時間を標準エラー出力に表示します。データの標準出力とは分かれるため、JSON 出力と併用できます。