hosted:artifact:set-note
Set or clear one artifact's note (markdown allowed). The new note replaces the old one, and an omitted or empty --note clears it. The node's revision is bumped when the note changes; setting the same text again can leave it as is. Needs the node's owner or an admin of it (a repository admin counts); an editor with only write access gets 403.
Reference for flywheel hosted:artifact:set-note.
Command Group
Hosted Repository
Summary
Set or clear one artifact's note (markdown allowed). The new note replaces the old one, and an omitted or empty --note clears it. The node's revision is bumped when the note changes; setting the same text again can leave it as is. Needs the node's owner or an admin of it (a repository admin counts); an editor with only write access gets 403.
Effect
DESTRUCTIVE: deletes, overwrites or revokes something
Usage
flywheel hosted:artifact:set-note <FLAGS>Required flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--node_id | string | Node UUID (not a slug) from node_id in hosted:node:list or graph:get. Missing or hidden: 404 where the command loads it. | ||
--artifact_id | string | Artifact on node_id, from artifact_id in hosted:artifact:list or an upload's finalize result. Unknown or on another node: 404. | ||
--expected_revision | integer | revision of node_id (root_node_id for tags) from hosted:node:get or your last write. Stale: 409 (some tools retry once); re-read and retry. |
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--note | string | The note the web UI and hosted:artifact:get show for the artifact; it replaces the current note, and does not touch the artifact's metadata. Omitted or empty: clears the note. | ||
--format | FORMAT | json, tsv, csv, table | Output format for command results. | |
--env | PROFILE | Select a CLI profile; unconfigured default requires FLYWHEEL_BASE_URL. | ||
--out | PATH | Write output to a file path, or use - for stdout. | ||
--open | Open browser-bound URLs when supported. | |||
--no-retry | Disable transient-error retries. | |||
--retry-max | N | Maximum transient-error retry attempts. | ||
--wait | Block on async operations until a terminal state is reached. | |||
--wait-timeout | SECONDS | 600 | Seconds to wait for --wait before timing out. Defaults to 600. | |
--allow-self | Allow mutating the currently active credential. | |||
--timeout | SECONDS | Set the per-request timeout budget in seconds. | ||
--idempotency-key | KEY | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | ||
--force | Force safety-gated operations where supported. | |||
--yes | Confirm forced compute:release-all --force. Other runtime commands do not read --yes. | |||
--debug | Print structured request debugging with secrets masked. | |||
--verbose | Print verbose progress for long-running operations. | |||
-h, --help | Show this help. |
Examples
Set an artifact's note.
flywheel hosted:artifact:set-note --node_id n_abc --artifact_id art_42 --expected_revision 7 --note "Best run so far"Clear an artifact's note.
flywheel hosted:artifact:set-note --node_id n_abc --artifact_id art_42 --expected_revision 8Output
Default format: human.
| Field | Type |
|---|---|
node | object |
artifact | object |