Command reference
deployments artifact
Run and message artifacts
| Command | Summary |
|---|---|
deployments artifact list | List artifacts |
deployments artifact upload | Create a customer artifact upload |
deployments artifact show | Show artifact metadata |
deployments artifact download | Create a scoped artifact access URL |
deployments artifact complete | Verify and complete a customer artifact upload |
deployments artifact delete | Delete an artifact and erase its stored bytes |
deployments artifact retention | Set or clear artifact retention |
deployments artifact list
List artifacts.
deployments artifact list- Calls
GET /v1/artifacts(SDKlistArtifacts). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
--run-id | string | Filter by run ID | ||
--thread-id | string | Filter by thread ID | ||
--type | string | Filter by artifact type | ||
--content-type | string | Filter by media type or family, such as image/* | ||
--created-after | string | Only artifacts created at or after this timestamp | ||
--created-before | string | Only artifacts created at or before this timestamp |
Also accepts the global flags.
deployments artifact upload
Create a customer artifact upload.
deployments artifact upload --name <name> --type <type> --file-name <file-name> --content-type <content-type> --byte-size <number> --sha256 <sha256>- Calls
POST /v1/artifacts(SDKcreateArtifactUpload). - Needs an environment:
--envor the saved context. - Output contains secrets. They are redacted unless you pass
--reveal.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--name | string | yes | Artifact name | |
--type | string | yes | Artifact type | |
--file-name | string | yes | Artifact file name | |
--content-type | string | yes | Artifact media type | |
--byte-size | string (number) | yes | Artifact byte size | |
--sha256 | string | yes | Lowercase SHA-256 digest | |
--visibility | string | private or organization | ||
--run-id | string | Associated run ID | ||
--thread-id | string | Associated thread ID | ||
--retention-expires-at | string | Canonical retention expiration | ||
--metadata | string (json) | Artifact metadata |
Also accepts the global flags.
deployments artifact show
Show artifact metadata.
deployments artifact show <id>- Calls
GET /v1/artifacts/{artifactId}(SDKgetArtifact). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments artifact download
Create a scoped artifact access URL.
deployments artifact download <id>- Calls
POST /v1/artifacts/{artifactId}/access-urls(SDKcreateArtifactAccessUrl). - Needs an environment:
--envor the saved context. - Output contains secrets. They are redacted unless you pass
--reveal.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--expires-in-seconds | string (number) | Access URL lifetime in seconds | ||
--disposition | string | attachment to make a browser save the file, or inline |
Also accepts the global flags.
deployments artifact complete
Verify and complete a customer artifact upload.
deployments artifact complete <id>- Calls
POST /v1/artifacts/{artifactId}/complete(SDKcompleteArtifactUpload). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments artifact delete
Delete an artifact and erase its stored bytes.
deployments artifact delete <id>- Calls
DELETE /v1/artifacts/{artifactId}(SDKdeleteArtifact). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments artifact retention
Set or clear artifact retention.
deployments artifact retention <id> --expected-version <number> --retention-expires-at <json>- Calls
PATCH /v1/artifacts/{artifactId}/retention(SDKupdateArtifactRetention). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--expected-version | string (number) | yes | Expected artifact version | |
--retention-expires-at | string (json) | yes | Canonical retention expiration string or null |
Also accepts the global flags.