hosted:tag:define
Commit a new tag definition under a scope node. It adds one definition under the scope node and assigns the tag to no node; use hosted:node-tag:assign.
Reference for flywheel hosted:tag:define.
Create and commit a tag immediately in the selected hosted repository. Put the five required fields (name, bg_color, text_color, one_only, track_history) in a JSON definition file, then run flywheel hosted:tag:define <scope_node_id> --repository-id <uuid> --definition-file tag.json. To read it, clone the hosted repository with flywheel repo:clone <uuid> <directory> and run flywheel repo:tag:list <scope_node_id> --repo <directory>. The optional history fields default to null/null/1 for a new tag; see the --definition-file help for all eight fields and validation.
Command Group
Hosted Repository
Summary
Commit a new tag definition under a scope node. It adds one definition under the scope node and assigns the tag to no node; use hosted:node-tag:assign.
Effect
changes data
Usage
flywheel hosted:tag:define <FLAGS> <scope_node_id>Arguments
| Argument | Required | Choices | Description |
|---|---|---|---|
<scope_node_id> | Yes | Tag scope node UUID. |
Required flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--repository-id | string | Hosted repository UUID. | ||
--definition-file | string | JSON object, not a text value file. Minimal: {"name":"Reviewed","bg_color":"#123456","text_color":"#ffffff","one_only":false,"track_history":false}. Complete: add "history_of_tag_id":null, "history_index":null, "history_next_index":1. Name: 1–256 Unicode code points; colors: # plus six hex digits; flags: booleans. Tracked history requires one_only=true. New tags start with null/null/1 history; updates must preserve the current history fields and counters. Other input keys are ignored by the file reader. |
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--message | string | Hosted commit message. | ||
--expected-head | string | Hosted head this write expects, as head from flywheel hosted:repository:head <repository_id>. When set, the automatic head read is skipped; if the head has moved, the write is refused with repository_head_mismatch: read the head again and retry. | ||
--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
Commit a new tag definition under a scope node.
flywheel hosted:tag:define --repository-id=<uuid> <scope_node_id> --definition-file=<definition-file> --format=jsonOutput
Default format: human.
| Field | Type |
|---|---|
commit_id | string |
head | string |
cursor | string |
receipt_sequence | integer |
tag_id | string |
warnings (optional) | array<string> |
hosted:repository:transfer
Transfer ownership of a hosted repository to another member; you remain admin.
hosted:tag:retire
Commit the retirement of a tag definition. The definition is marked retired: nodes stop showing the tag and it cannot be assigned again (`tag definition is not active`). Existing assignment and history records are kept, not deleted.