# update

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

## Usage

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

Update an artifact's notes Required scopes: ARTIFACT_WRITE

## Arguments

| **Argument** | **Description** |
| :--- | :--- |
| `identifier` | Artifact identifier (human-readable) (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 |
| `--scope <scope>` | Force scope (WORKSPACE, PROJECT). By default calculated by provided options and environmental variables (--project, BUDDY_PROJECT, linked project) |
| `-p, --project <name>` | Project name. Can be set via variable: BUDDY_PROJECT |
| `--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 |

Documentation for bdy v1.25.38

## Examples

### Set the note read by AI agents

```bash
bdy art update artifact-identifier --agent-note "built by the release pipeline only"
```

### Set note of a project artifact as json

```bash
bdy art update artifact-identifier -p project --note "frontend bundle" --format json
```


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