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

FlagValueDefaultChoicesDescription
--node_idstringOwning node.
--expected_revisionintegerOptimistic lock.
--itemsjsonUpload 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

FlagValueDefaultChoicesDescription
--formatFORMATjson, tsv, csv, tableOutput format for command results.
--envPROFILEUse a configured CLI profile for this invocation.
--outPATHWrite output to a file path, or use - for stdout.
--openOpen browser-bound URLs when supported.
--no-retryDisable transient-error retries.
--retry-maxNMaximum transient-error retry attempts.
--waitBlock on async operations until a terminal state is reached.
--wait-timeoutSECONDS600Seconds to wait for --wait before timing out. Defaults to 600.
--allow-selfAllow mutating the currently active credential.
--timeoutSECONDSSet the per-request timeout budget in seconds.
--idempotency-keyKEYReuse an Idempotency-Key so ambiguous write failures can be retried with the same key.
--forceForce safety-gated operations where supported.
--yesSkip confirmation prompts for destructive operations.
--debugPrint structured request debugging with secrets masked.
--verbosePrint verbose progress for long-running operations.
-h, --helpShow 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.json

Read 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"}]