mirror of
https://github.com/docker/docs.git
synced 2026-11-04 10:01:00 +00:00
David Karlsson
c64e3927ef
## Summary Update the Sandbox documentation for the v0.48.0 CLI refactor: renamed flags, settings commands, terminal output, structured output, and non-interactive confirmations. Add a migration reference for scripts and CI workflows, with a [**Copy as prompt** button](https://deploy-preview-26314--docsdocker.netlify.app/ai/sandboxes/workflows/automation/#update-scripts-for-v0480) that copies agent instructions and the section Markdown. This PR targets `main` independently of the other PRs in the sbx/v0.48.0 milestone. It keeps the generated reference import separate from documentation edits: - Vendor the 120 generated CLI YAML files - Update command examples and guidance. Historical release notes retain their original command spellings. The other milestone PRs cover separate release features; this PR covers the CLI migration. @netlify /ai/sandboxes/workflows/automation/ Generated by Codex
42 lines
1.5 KiB
YAML
42 lines
1.5 KiB
YAML
name: sbx kit pull
|
|
synopsis: Pull a kit artifact from an OCI registry
|
|
experimental: true
|
|
description: |-
|
|
Pull a kit artifact from an OCI registry and save its layer payload to a file.
|
|
|
|
The reference should be in the format "registry/repo:tag" or
|
|
"registry/repo@sha256:digest" (e.g., "ghcr.io/myorg/my-plugin:1.0").
|
|
|
|
The file extension is chosen automatically based on the kit's format:
|
|
schemaVersion: "1" → <name>.zip (legacy ZIP archive)
|
|
schemaVersion: "2" → <name>.tar.gz (standard OCI tar+gzip layer)
|
|
|
|
The registry must support HTTPS.
|
|
|
|
Authentication: sbx registry secrets (sbx secret set --registry) take priority, falling back to the Docker credential store.
|
|
usage: sbx kit pull REFERENCE [flags]
|
|
options:
|
|
- name: help
|
|
shorthand: h
|
|
default_value: "false"
|
|
usage: help for pull
|
|
- name: output
|
|
shorthand: o
|
|
usage: 'Output file path (default: derived from reference + format)'
|
|
inherited_options:
|
|
- name: cloud
|
|
default_value: "false"
|
|
usage: |
|
|
Dispatch to Docker Cloud Sandboxes API instead of local sandboxd (supported by a growing set of verbs — run 'sbx --cloud --help' for the current list)
|
|
- name: debug
|
|
shorthand: D
|
|
default_value: "false"
|
|
usage: Enable debug logging
|
|
example: |4-
|
|
sbx kit pull ghcr.io/myorg/my-kit:1.0
|
|
|
|
# Choose where to save the payload
|
|
sbx kit pull ghcr.io/myorg/my-kit:1.0 --output my-kit.tar.gz
|
|
see_also:
|
|
- sbx kit - (Experimental) Manage kit artifacts
|