Documentation
¶
Overview ¶
--- relationships:
references: [CONTRIBUTING]
---
Package cli composes the devcontainer libraries into the dcb command surface. Run writes one JSON result line except for help and exec. Help is plain text on stdout. Exec passes child streams through unchanged. Diagnostics and other build/lifecycle output use stderr. --- relationships:
references: [CONTRIBUTING]
---
--- relationships:
references: [CONTRIBUTING]
---
--- relationships:
references: [CONTRIBUTING]
---
relationships:
references: [options_configuration, stage, features]
--- relationships:
references: [CONTRIBUTING]
---
relationships:
references: [cli, ../../test/parity/README]
--- relationships:
references: [CONTRIBUTING]
---
--- relationships:
references: [CONTRIBUTING]
---
--- relationships:
references: [CONTRIBUTING]
---
relationships:
references: [config, host, lifecycle, metadata]
relationships:
references: [cli, ../../reference/cli/src/spec-node/devContainersSpecCLI]
relationships:
references: [config, metadata, host, lifecycle]
relationships:
references: [config, stage, ../../internal/datafolder/staging]
--- relationships:
references: [CONTRIBUTING]
---
relationships:
references: [build, ../buildkit/output]
relationships:
references: [build, stage, ../builder/builder]
relationships:
references: [lifecycle, host, ../host/runner/controls]
relationships:
references: [build, stage, ../features/lockfile]
relationships:
references: [config, host, ../workspace/workspace, ../../reference/cli/src/spec-node/devContainersSpecCLI]
relationships:
references: [options_environment, ../host/runner/probe]
relationships:
references: [cli, ../host/runner/runner, ../../reference/cli/src/spec-node/devContainersSpecCLI]
--- relationships:
references: [CONTRIBUTING]
---
--- relationships:
references: [CONTRIBUTING]
---
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisteredOptions ¶
RegisteredOptions reports the real command tree's accepted long flag names. The empty command path is the root. Actions are never executed. Inherited and hidden flags are included; positional arguments and shorthands are not flags.
func Run ¶
func Run(ctx context.Context, args []string, version string, stdin io.Reader, stdout, stderr io.Writer) int
Run executes one invocation. Exit codes: 0 success, 1 operation failure, 2 invalid invocation. Exec returns the container command's nonzero exit code. Help is plain text. Archive output to stdout emits no JSON result. Exec emits no result after starting the child; operation failures before the child use stderr and exit 1. Invalid invocations use JSON. Embedded skills are carried in the JSON result as strings.
Types ¶
This section is empty.
Source Files
¶
- build.go
- cli.go
- config.go
- exec.go
- features_configuration.go
- host.go
- inventory.go
- lifecycle.go
- log.go
- mask.go
- metadata.go
- options_boolean.go
- options_configuration.go
- options_data_folders.go
- options_environment.go
- options_exporters.go
- options_feature_controls.go
- options_gpu.go
- options_lifecycle.go
- options_lockfile.go
- options_mounts.go
- options_probe.go
- options_terminal.go
- skills.go
- stage.go