# update

## Usage

```bash
bdy environment update|edit [options] <identifier>
```

## Arguments

| **Argument** | **Description** |
| :--- | :--- |
| `identifier` | Environment identifier (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 |
| `-n, --name <name>` | Environment name |
| `--tags <tags>` | Comma-separated list of tags |
| `--public-url <url>` | Public URL of the environment |
| `--icon <icon>` | Icon of the environment (an emoji, e.g. 🚀) |
| `--note <note>` | Resource note |
| `--agent-note <note>` | Note for AI agents operating on this resource; stored as agent_note and meant to be read before acting on the resource |
| `--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 |

## Examples

### Rename environment

```bash
bdy env edit environment-identifier -n "New name"
```

### Set tags

```bash
bdy env edit environment-identifier --tags prod,stable
```

### Set icon

```bash
bdy env edit environment-identifier --icon 🚀
```

### Clear note

```bash
bdy env edit environment-identifier --note ""
```

### Return the result as JSON

```bash
bdy environment update staging --name Staging --format json
```


---
Original source: https://buddy.works/docs/cli/environment/update