From 1cccec18ca5298bcaa662ab69826f7f3b7cd0b43 Mon Sep 17 00:00:00 2001 From: Rodrigo Barbosa Date: Thu, 4 Jun 2026 14:14:41 -0300 Subject: [PATCH] docs(cli): add image metadata/tags command documentation 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 --- CLI-COMMANDS.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/CLI-COMMANDS.md b/CLI-COMMANDS.md index d3532a8d..32064e80 100644 --- a/CLI-COMMANDS.md +++ b/CLI-COMMANDS.md @@ -91,6 +91,32 @@ roboflow model star --unstar `model star` is NAS-only by server-side design; non-NAS modelTypes return `code: "MODEL_NOT_NAS"`. +### Update image metadata and tags + +```bash +# Single image: set metadata + add tags +roboflow image metadata -m '{"camera": "cam1"}' --tags "review,v2" + +# Remove metadata keys +roboflow image metadata --remove-metadata "old_key" + +# Remove tags +roboflow image metadata --remove-tags "draft" + +# Batch: update multiple images (async), poll for completion +roboflow image metadata img1,img2,img3 --tags "processed" --poll + +# Batch with timeout +roboflow image metadata img1,img2 -m '{"status": "done"}' --poll --timeout 600 + +# Tag alias works identically (hidden command) +roboflow image tag --tags "review" --remove-tags "draft" +``` + +Single image ID updates synchronously. Multiple comma-separated IDs use the +batch async endpoint (up to 1000 images). Use `--poll` to block until +completion; without it the command returns the `taskId` immediately. + ### Search and export ```bash @@ -334,7 +360,7 @@ Version numbers are always numeric — that's how `x/y` is disambiguated between | `workspace` | List and inspect workspaces | | `project` | List, get, create projects | | `version` | List, get, download, export dataset versions | -| `image` | Upload, get, search, tag, delete, annotate images | +| `image` | Upload, get, search, metadata, tag, delete, annotate images | | `model` | List, get, upload trained models | | `train` | Start model training | | `infer` | Run inference on images |