---
title: グローバルオプション
description: Orchestor CLI の共通オプションと使い方。
canonical_url: https://orchestor.io/docs/cli/global-flags
markdown_url: https://orchestor.io/docs/cli/global-flags.md
contentType: reference
---

# グローバルオプション

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

## ヘルプ

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

```bash
orc brands list --help
```

## ワークスペース

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

```bash
orc brands list --workspace <workspace-id>
```

## JSON 出力

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

```bash
orc brands list --json
orc brands list --pretty
```

## 出力形式

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

```bash
orc brands list --format table
orc brands list --format csv
```

## フィールドの抽出

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

```bash
orc brands list --field id
```

## 値だけを出力

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

```bash
orc brands list --field id --raw
```

## ファイルへの出力

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

```bash
orc brands list --json --output brands.json
```

## ページ送り

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

```bash
orc brands list --no-pager
```

## リクエストの事前確認

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

```bash
orc brands list --dry-run
```

## 確認の省略

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

```bash
orc brands delete <brand-id> --yes
```

## ページサイズ

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

```bash
orc brands list --page-size 25
```

## すべてのページを取得

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

```bash
orc brands list --page-all
orc brands list --page-all --output brands.ndjson
```

## 標準入力

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

```bash
orc brands create --stdin --dry-run < brand.json
```

## リクエスト時間

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

```bash
orc brands list --json --timing
```

## 読み取り専用モード

`--readonly` を付けると、データを変更しうるリクエストを送信前に止めます。環境変数 `ORCHESTOR_READONLY=1` でも同じです。取得系のリクエストと、`sheets values get` のように読み取り専用と明示された POST だけを送ります。調べるだけのエージェントに渡すときに使います。

```bash
orc sheets values get YOUR_CONNECTION_ID SPREADSHEET_ID --ranges 'Metrics!A1:D20' --readonly
ORCHESTOR_READONLY=1 orc sheets get YOUR_CONNECTION_ID SPREADSHEET_ID
```

## 外部テキストの目印付け

`--wrap-untrusted` を付けると、セルの値・メモ・タイトルなど外部から来たテキストを `<<<EXTERNAL_UNTRUSTED_CONTENT id="…">>>` の目印で囲み、AI モデルの特殊トークンや偽の目印を無害化して出力します。出力には `externalContent` の注記が付きます。取得した内容を AI モデルに読ませるときに、指示として扱わせないために使います。

```bash
orc sheets values get YOUR_CONNECTION_ID SPREADSHEET_ID --ranges 'Inbox!A1:C50' --wrap-untrusted --json
```

---

[Documentation index](https://orchestor.io/docs/llms.txt)