sandbox

package

v0.7.1 Latest Latest Go to latest Published: Mar 27, 2026 License: MIT Imports: 31 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/CircleCI-Public/chunk-cli

Links

Open Source Insights

Documentation ¶

Index ¶

func AddSSHKey(ctx context.Context, client *circleci.Client, ...) (*circleci.AddSSHKeyResponse, error)
func Create(ctx context.Context, client *circleci.Client, orgID, name, image string) (*circleci.Sandbox, error)
func Exec(ctx context.Context, client *circleci.Client, sandboxID, command string, ...) (*circleci.ExecResponse, error)
func InteractiveShell(ctx context.Context, session *Session) error
func List(ctx context.Context, client *circleci.Client, orgID string) ([]circleci.Sandbox, error)
func Prepare(ctx context.Context, claude *anthropic.Client, dockerSudo bool, ...) error
func SSH(ctx context.Context, client *circleci.Client, ...) error
func ShellEscape(arg string) string
func ShellJoin(args []string) string
func Sync(ctx context.Context, client *circleci.Client, ...) error
type ExecResult
- func ExecOverSSH(ctx context.Context, session *Session, command string, stdin io.Reader) (*ExecResult, error)
type Session
- func OpenSession(ctx context.Context, client *circleci.Client, ...) (*Session, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddSSHKey ¶

func AddSSHKey(ctx context.Context, client *circleci.Client, sandboxID, publicKey, publicKeyFile string) (*circleci.AddSSHKeyResponse, error)

func Create ¶

func Create(ctx context.Context, client *circleci.Client, orgID, name, image string) (*circleci.Sandbox, error)

func Exec ¶

func Exec(ctx context.Context, client *circleci.Client, sandboxID, command string, args []string) (*circleci.ExecResponse, error)

func InteractiveShell ¶ added in v0.7.1

func InteractiveShell(ctx context.Context, session *Session) error

InteractiveShell opens an interactive shell session to the sandbox with PTY.

func List ¶

func List(ctx context.Context, client *circleci.Client, orgID string) ([]circleci.Sandbox, error)

func Prepare ¶

func Prepare(ctx context.Context, claude *anthropic.Client, dockerSudo bool, io iostream.Streams, stdin io.Reader) error

Prepare generates a Dockerfile, builds it, and runs tests inside the container.

func SSH ¶

func SSH(ctx context.Context, client *circleci.Client, sandboxID, identityFile, authSock string, args []string, io iostream.Streams) error

SSH opens a session and either runs a command or starts an interactive shell.

func ShellEscape ¶

func ShellEscape(arg string) string

ShellEscape escapes a string for safe use in a POSIX shell single-quoted context.

func ShellJoin ¶

func ShellJoin(args []string) string

ShellJoin joins args into a shell command string with POSIX single-quote escaping.

func Sync ¶

func Sync(ctx context.Context, client *circleci.Client, sandboxID, identityFile, authSock, dest string, bootstrap bool, io iostream.Streams) error

Sync synchronises local changes to a sandbox over SSH. If bootstrap is true it clones the repo on the sandbox first.

Types ¶

type ExecResult ¶

type ExecResult struct {
	Stdout   string
	Stderr   string
	ExitCode int
}

ExecResult holds the output of a command executed over SSH.

func ExecOverSSH ¶

func ExecOverSSH(ctx context.Context, session *Session, command string, stdin io.Reader) (*ExecResult, error)

ExecOverSSH connects to the sandbox via SSH-over-TLS and executes a command.

type Session ¶

type Session struct {
	URL          string // sandbox domain
	IdentityFile string // path to SSH private key (empty when using agent)
	KnownHosts   string // path to known_hosts file
	UseAgent     bool   // true when authenticating via ssh-agent
	AuthSock     string // SSH_AUTH_SOCK path (only used when UseAgent is true)
}

Session holds the info needed to SSH into a sandbox.

func OpenSession ¶

func OpenSession(ctx context.Context, client *circleci.Client, sandboxID, identityFile, authSock string) (*Session, error)

OpenSession registers an SSH key with the sandbox and returns session info. authSock is the SSH_AUTH_SOCK path; when non-empty and no identityFile is given, the agent is tried first.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL