artifacts:upload
One-shot upload: prepare + PUT + finalize from a single invocation.
Reference for flywheel artifacts:upload.
Command Group
Artifacts & Files Commands
Summary
One-shot upload: prepare + PUT + finalize from a single invocation.
Usage
flywheel artifacts:upload <FLAGS>Aliases
aru
Required flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--node_id | string | Owning node. | ||
--expected_revision | integer | Optimistic lock. | ||
--items | json | Upload item JSON array. Supports inline JSON, @file paths, @- stdin, and @@ literal escaping. Each item requires local_path and artifact_type (one of: text, table, json, image, banner, html, plotly_html, vega, checkpoint, binary, diff_carousel); optional media_type, title, execution_id, note, metadata. |
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--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
Upload a file.
flywheel artifacts:upload --node_id n --expected_revision 3 --items '[{"local_path":"./report.pdf","artifact_type":"binary"}]'Upload items from a JSON file.
flywheel artifacts:upload --node_id n --expected_revision 3 --items=@./items.jsonRead upload items JSON from stdin.
cat items.json | flywheel artifacts:upload --node_id n --expected_revision 3 --items=@-Escape a literal JSON value that begins with @.
flywheel artifacts:upload --node_id n --expected_revision 3 --items=@@[{"local_path":"./report.pdf","artifact_type":"binary"}]