Skip to content

Commit e33e0ef

Browse files
digaobarbosaclaude
andauthored
docs(cli): add image metadata/tags command documentation (#489)
Document the new `roboflow image metadata` command added in #483, covering single-image sync, batch async with polling, and all flags. Ref: DATAMAN-345 Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a7f4bdd commit e33e0ef

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

CLI-COMMANDS.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,32 @@ roboflow model star <modelId> --unstar
9191
`model star` is NAS-only by server-side design; non-NAS modelTypes return
9292
`code: "MODEL_NOT_NAS"`.
9393

94+
### Update image metadata and tags
95+
96+
```bash
97+
# Single image: set metadata + add tags
98+
roboflow image metadata <image_id> -m '{"camera": "cam1"}' --tags "review,v2"
99+
100+
# Remove metadata keys
101+
roboflow image metadata <image_id> --remove-metadata "old_key"
102+
103+
# Remove tags
104+
roboflow image metadata <image_id> --remove-tags "draft"
105+
106+
# Batch: update multiple images (async), poll for completion
107+
roboflow image metadata img1,img2,img3 --tags "processed" --poll
108+
109+
# Batch with timeout
110+
roboflow image metadata img1,img2 -m '{"status": "done"}' --poll --timeout 600
111+
112+
# Tag alias works identically (hidden command)
113+
roboflow image tag <image_id> --tags "review" --remove-tags "draft"
114+
```
115+
116+
Single image ID updates synchronously. Multiple comma-separated IDs use the
117+
batch async endpoint (up to 1000 images). Use `--poll` to block until
118+
completion; without it the command returns the `taskId` immediately.
119+
94120
### Search and export
95121

96122
```bash
@@ -334,7 +360,7 @@ Version numbers are always numeric — that's how `x/y` is disambiguated between
334360
| `workspace` | List and inspect workspaces |
335361
| `project` | List, get, create projects |
336362
| `version` | List, get, download, export dataset versions |
337-
| `image` | Upload, get, search, tag, delete, annotate images |
363+
| `image` | Upload, get, search, metadata, tag, delete, annotate images |
338364
| `model` | List, get, upload trained models |
339365
| `train` | Start model training |
340366
| `infer` | Run inference on images |

0 commit comments

Comments
 (0)