# get

> For AI agents: the complete documentation index is at https://buddy.works/llms.txt

## Usage

```bash
bdy variable get [options] <key>
```

Show variable details Required scopes: VARIABLE_READ

## Arguments

| **Argument** | **Description** |
| :--- | :--- |
| `key` | Variable key (name) (required) |

## Options

| **Option** | **Description** |
| :--- | :--- |
| `--context <name>` | Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation. |
| `--examples` | Show only examples; with this flag --format accepts text, json or jsonl |
| `--verbose` | Show REST API requests, responses, timing and retries on stderr |
| `-w, --workspace <domain>` | Workspace URL handle. Can be set via variable: BUDDY_WORKSPACE |
| `-p, --project <name>` | Project name. Can be set via variable: BUDDY_PROJECT |
| `--pipeline <identifier>` | Pipeline identifier to scope the variable to. Requires --project |
| `--environment <identifier>` | Environment identifier to scope the variable to. Resolves a workspace environment; add --project to point at a project environment |
| `--sandbox <identifier>` | Sandbox identifier to scope the variable to. Resolves a workspace sandbox; add --project to point at a project sandbox |
| `--scope <scope>` | Force scope (WORKSPACE, PROJECT, ENVIRONMENT, PIPELINE, SANDBOX). By default calculated by provided options and environmental variables (--pipeline, --environment, --sandbox, --project, BUDDY_PROJECT, linked project) |
| `--format <text\|json>` | Output format: json, text. JSON CLI errors: {error:{code,message,hint}}, exit 1. Default: text (choices: "text", "json") |
| `-h, --help` | display help for command |

Documentation for bdy v1.25.34

## Examples

### Get variable details

```bash
bdy var get API_URL
```

### Get a pipeline variable as json

```bash
bdy var get API_URL -p project --pipeline pipeline-identifier --format json
```


---
Original source: https://buddy.works/docs/cli/variable/get