Sign inSign up

docker/sbx-kit-github-clone:latest

Multi-platform
Manifest digest

sha256:2aa2a7cebf9b7b2d74f059bc1486f9a7a6ce06718e89f0d77b2dd0c029be404b

Last pushed

9 days by cdupuis

Type

Sandbox Kit

Manifest digest

sha256:2aa2a7cebf9b7b2d74f059bc1486f9a7a6ce06718e89f0d77b2dd0c029be404b

MIXIN

Clones a GitHub repository into the sandbox at create time, using the gh CLI with a proxy-managed GH_TOKEN sentinel. Auto-installs gh if the base image doesn't have it.


Arguments
NameRequiredDefaultDescription
dirOptional/project

Absolute directory inside the sandbox to clone into. If the directory already exists and is non-empty, the clone is skipped (the mixin re-runs cleanly on `sbx create` retries).

refOptional

Optional git ref (branch, tag, or 7–40 hex commit SHA) to check out. Empty (the default) clones the repo's default branch.

repoRequired—

GitHub repository to clone. Accepts the `owner/name` shorthand, a full `https://github.com/owner/name[.git]` URL, or an `[email protected]:owner/name[.git]` SSH URL. Any other form is rejected before the clone shells out.


CapabilitiesExpand a row to see its full configuration.
TypeRequiredDescription
com.docker.sandbox/network-policy@1Required—
com.docker.sandbox/lifecycle@1Required—
com.docker.sandbox/agent-context@1Required—

Apply this mixin to a sandbox

sbx run <agent> --kit docker/sbx-kit-github-clone:latest --set repo=<repo>

Make sure you have docker sbx installed

Run the following command to install sbx on your machine.

macOS
brew install docker/tap/sbx
Windows
winget install Docker.sbx
Learn more about docker sbx⁠