---
title: Global Options
description: Options shared by Orchestor CLI commands, with usage examples.
canonical_url: https://orchestor.io/docs/en/cli/global-flags
markdown_url: https://orchestor.io/docs/en/cli/global-flags.md
contentType: reference
---

# Global Options

Global options are shared by multiple Orchestor CLI data commands. Availability depends on the command; check its `--help` output. Local configuration commands list their supported options on their own reference pages.

## Help

Use `--help` to display usage and supported options for a command.

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

## Workspace

Use `--workspace` to select a workspace by ID. You can also set the `ORCHESTOR_WORKSPACE_ID` environment variable.

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

## JSON output

Use `--json` for compact JSON or `--pretty` for indented JSON. Both wrap the response in an envelope.

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

## Output format

Use `--format` to select `json`, `table`, `yaml`, `csv`, or `raw`. The default is human-readable output.

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

## Field selection

Use `--field` to extract a value from the response. Dotted paths are supported. `--fields` is an alias.

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

## Raw output

Use `--raw` to print extracted values without JSON quotes or an envelope. Array values are printed one per line for use in other commands.

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

## File output

Use `--output` to write the result to a file instead of standard output.

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

## Pager

Use `--no-pager` to disable the interactive pager. The pager is disabled by default when standard output is not a terminal.

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

## Dry run

Use `--dry-run` to preview the request without sending it to the API.

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

## Confirmation

Use `--yes` to skip confirmation prompts for destructive operations. This option does not grant permissions.

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

## Page size

Use `--page-size` on paginated list commands to set the maximum number of items per page. It maps to the API’s `limit` parameter.

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

## All pages

Use `--page-all` on paginated list commands to stream every page as NDJSON, one record per line. Do not combine it with `--json`, `--pretty`, or another output format.

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

## Standard input

Use `--stdin` to read a JSON resource definition from standard input when creating or updating a resource. `--from-stdin` is an alias.

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

## Request timing

Use `--timing` to print request duration to standard error. Timing stays separate from the data on standard output, so it can be used with JSON output.

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

## Read-only mode

Use `--readonly` to block any request that can change data before it is sent. `ORCHESTOR_READONLY=1` does the same. Only reads, and POST requests marked read-only such as `sheets values get`, are sent. Use it when handing the CLI to an agent that should only look.

```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
```

## Untrusted content wrapping

Use `--wrap-untrusted` to wrap external text such as cell values, notes, and titles in `<<<EXTERNAL_UNTRUSTED_CONTENT id="…">>>` markers, neutralizing model special tokens and spoofed markers. The output also carries an `externalContent` note. Use it when an AI model will read fetched content, so the content is treated as data rather than instructions.

```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)