repo:artifact:set-metadata
Stage a replacement for exactly one artifact metadata field from --metadata-file or one inline flag.
Reference for flywheel repo:artifact:set-metadata.
Command Group
Local Repository
Summary
Stage a replacement for exactly one artifact metadata field from --metadata-file or one inline flag.
Usage
flywheel repo:artifact:set-metadata [FLAGS] <ARGS>…Arguments
| Argument | Required | Choices | Description |
|---|---|---|---|
<owner_kind> | Yes | node, edge | Artifact owner kind. |
<owner_id> | Yes | Artifact owner UUID. | |
<artifact_id> | Yes | Artifact UUID. |
Required flags
None.
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--repo | string | Local repository filesystem path. | ||
--personal | Use the configured personal repository. | |||
--metadata-file | string | Artifact metadata JSON file containing exactly one of name, media_type, notes, or tags — see --schema. Mutually exclusive with the inline flags below. | ||
--name | string | Inline replacement artifact name; use alone, without the other metadata flags. | ||
--media-type | string | Inline replacement artifact media type; use alone, without the other metadata flags. | ||
--notes | string | Inline replacement artifact notes; use alone, without the other metadata flags. | ||
--tags | string | Inline replacement comma-separated artifact tags; use alone, without the other metadata flags. | ||
--schema | Print the artifact metadata schema and example. | |||
--format | FORMAT | json, tsv, csv, table | Output format for command results. | |
--env | PROFILE | Use a configured CLI profile for this invocation. | ||
--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 | Skip confirmation prompts for destructive operations. | |||
--debug | Print structured request debugging with secrets masked. | |||
--verbose | Print verbose progress for long-running operations. | |||
-h, --help | Show this help. |
Examples
Replace the artifact's notes using an inline flag.
flywheel repo:artifact:set-metadata node <owner_id> <artifact_id> --repo <path> --notes revisedReplace one field using a single-field metadata JSON file.
flywheel repo:artifact:set-metadata node <owner_id> <artifact_id> --repo <path> --metadata-file metadata.jsonPrint the complete machine-readable single-field contract and a valid example.
flywheel repo:artifact:set-metadata --schema --format=jsonrepo:artifact:get
Read one artifact and its references. Defaults to committed local state; use --staged to inspect saved pending work.
repo:backup
Create and verify a local repository backup without contacting a service, then record its completion for this checkout. If recording fails, the verified archive remains restorable and the command reports its destination and digest.