shell

package

Go to main page

Versions in this module

v0

v0.3.0

Nov 5, 2026

Changes in this version

+ func SecretEnv(ctx context.Context) map[string]string

+ func WithSecretEnv(ctx context.Context, env map[string]string) context.Context

v0.2.2

Oct 25, 2026

v0.2.1

Oct 25, 2026

Changes in this version

+ func IgnoreTerminalStops()

+ func KillAll()

+ func Start(_ context.Context, cmd *exec.Cmd) (release func(), err error) — js/wasm, windows/amd64

+ func Start(ctx context.Context, cmd *exec.Cmd) (release func(), err error) — darwin/amd64, linux/amd64

v0.2.0

Oct 25, 2026

Changes in this version

type BuildMetadata

+ func MetadataFrom(ctx context.Context) BuildMetadata

type RunnerSpec

+ Caches map[string]string

+ Sandbox bool

v0.1.0

Oct 15, 2026

Changes in this version

+ const SignalledExitCode

+ const SpillMaxBytes

+ const SpillPreviewBytes

+ func BuildEnv(ctx context.Context) map[string]string

+ func BuildEnvNames() []string

+ func CanceledError(ctx context.Context) error

+ func CloseRunner(r Runner, label string)

+ func FormatBytes(n int) string

+ func HostEnv() []string

+ func IsExitError(err error) bool

+ func IsReadOnly(ctx context.Context) bool

+ func NewPrefixedStream(label string, dst io.Writer) (w io.Writer, flush func())

+ func OwnerHost() string

+ func OwnershipLabels() map[string]string

+ func PrefixLines(label, s string) string

+ func PrepareImages(ctx context.Context, images []string) error

+ func ProcessGone(pid int) bool

+ func ReadOnly(ctx context.Context) context.Context

+ func ResolveMountPath(cwd string) (string, error)

+ func Run(ctx context.Context, r Runner, script string) error

+ func RunCapture(ctx context.Context, r Runner, script string) ([]byte, error)

+ func RunCaptureFull(ctx context.Context, r Runner, script string) (stdout, stderr string, exitCode int, err error)

+ func RunCaptureFullLimited(ctx context.Context, r Runner, script string, maxBytes int, spillDir string) (stdout, stderr string, exitCode int, err error)

+ func RunCaptureFullLimitedStreamed(ctx context.Context, r Runner, script string, maxBytes int, spillDir string) (stdout, stderr string, exitCode int, err error)

+ func RunShell(ctx context.Context, command, cwd string) error

+ func RunShellCapture(ctx context.Context, command, cwd string) ([]byte, error)

+ func RunShellCaptureFull(ctx context.Context, command, cwd string) (stdout, stderr string, exitCode int, err error)

+ func SpillPointerMessage(totalBytes int, path string, preview []byte) string

+ func SweepOrphanedContainers(ctx context.Context, dockerHost string)

+ func SweepOrphanedContainersOn(ctx context.Context, client *dockerapi.Client)

+ func ValidateDocker(ctx context.Context) error

+ func WidenSettleBoundForTest(bound time.Duration) (restore func())

+ func WithBuildMetadata(ctx context.Context, m BuildMetadata) context.Context

+ func WrapIfCanceled(ctx context.Context, err error) error

+ type BuildMetadata struct

+ JobName string

+ PipelineName string

+ PipelineRevision string

+ RunID string

+ URL string

+ type Capture struct

+ func NewCapture(maxBytes int, spillDir string) *Capture

+ func (c *Capture) Result() string

+ func (c *Capture) Write(p []byte) (int, error)

+ type Command struct

+ Capture bool

+ ExitAsData bool

+ Limit int

+ Script string

+ SpillDir string

+ Stdin bool

+ Stream Streams

+ func (c Command) Output(ctx context.Context, label string) *Output

+ type DockerRunner struct

+ Image string

+ func (d DockerRunner) Close() error

+ func (d DockerRunner) Exec(ctx context.Context, cmd Command) (Result, error)

+ func (d DockerRunner) WithLabel(label string) Runner

+ type ExitError struct

+ Code int

+ Command string

+ Venue string

+ func (e *ExitError) Error() string

+ func (e *ExitError) ExitCode() int

+ type HostRunner struct

+ func (HostRunner) Close() error

+ func (h HostRunner) Exec(ctx context.Context, cmd Command) (Result, error)

+ func (h HostRunner) WithLabel(label string) Runner

+ type Output struct

+ Stderr io.Writer

+ Stdout io.Writer

+ func (o *Output) Flush()

+ func (o *Output) Result(code int) Result

+ type RemoteInput struct

+ Digest string

+ Holder string

+ type Result struct

+ Code int

+ Stderr string

+ Stdout string

+ type Runner interface

+ Close func() error

+ Exec func(ctx context.Context, cmd Command) (Result, error)

+ WithLabel func(label string) Runner

+ func NewRunner(spec RunnerSpec) (Runner, error)

+ type RunnerSpec struct

+ CPUShares int

+ Cwd string

+ DeferFetch bool

+ DockerDial func(ctx context.Context) (net.Conn, error)

+ DockerHost string

+ Env []string

+ EnvValues map[string]string

+ Fetch []string

+ FetchAll bool

+ HoldAs string

+ Image string

+ Keep bool

+ MemoryBytes int64

+ MountPath string

+ Network string

+ Privileged bool

+ RemoteInputs map[string]RemoteInput

+ ReusedWarm bool

+ Subdir string

+ User string

+ Volumes []string

+ Worker string

+ WorkerTag string

+ type Streams uint8

+ const StreamBoth

+ const StreamStderr

+ const StreamStdout

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