repo:artifact:download

Download current-head artifact bytes, fetching and caching a remote-only object when needed; requires --out or --checkout-only.

Reference for flywheel repo:artifact:download.

If the download of the artifact's object fails (the connection is refused or drops, the request times out, the answer can't be read, or HTTP 408, 429, 502, 503 or 504 is still the answer after the CLI's retries), the error keeps its code and adds step, artifact_download, and next_action, the same command as typed, with the same arguments. The command has no --idempotency-key, so the rerun has none. It writes nothing, neither the --out file nor the checkout's copy of the object, until it has the object; run next_action once the hosted service can be reached again. A hosted repository_busy answer gets a step and this next_action too, and keeps its code repository_busy.

Command Group

Local Repository

Summary

Download current-head artifact bytes, fetching and caching a remote-only object when needed; requires --out or --checkout-only.

Usage

flywheel repo:artifact:download [FLAGS] <artifact_id>

Arguments

ArgumentRequiredChoicesDescription
<artifact_id>Yesartifact_id UUID.

Required flags

None.

Optional flags

FlagValueDefaultChoicesDescription
--repostringLocal repository filesystem path.
--personalUse the configured personal repository.
--artifact-idstringNamed alternative to <artifact_id>.
--outstringWrite the artifact's bytes to a file path, or use - for stdout. Required unless --checkout-only.
--checkout-onlyOnly save the artifact's file in the repository's checkout, where flywheel ui and later downloads read it; write no other copy and print what was saved. Use instead of --out.
--formatFORMATjson, tsv, csv, tableOutput format for command results.
--envPROFILEUse a configured CLI profile for this invocation.
--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

Write the artifact bytes to a file.

flywheel repo:artifact:download <artifact_id> --repo <path> --out=./artifact.bin

Write only the artifact bytes to stdout.

flywheel repo:artifact:download <artifact_id> --repo <path> --out=-

Save the artifact's file in the checkout only, without writing another copy.

flywheel repo:artifact:download <artifact_id> --repo <path> --checkout-only