Documentation
¶
Index ¶
- Constants
- func BuildRoot() *cobra.Command
- func Execute()
- func NewBuildCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewDeleteCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewDownCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewExecCmd(f *flags.GlobalFlags) *cobra.Command
- func NewExportCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewImportCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewListCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewLogsCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewLogsDaemonCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewOutdatedCmd(f *flags.GlobalFlags) *cobra.Command
- func NewPingCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewReadConfigurationCmd(f *flags.GlobalFlags) *cobra.Command
- func NewRenameCmd(globalFlags *flags.GlobalFlags) *cobra.Command
- func NewRootCmd() *cobra.Command
- func NewRunUserCommandsCmd(f *flags.GlobalFlags) *cobra.Command
- func NewRunUserCommandsCmdAlias(f *flags.GlobalFlags) *cobra.Command
- func NewSSHCmd(f *flags.GlobalFlags) *cobra.Command
- func NewSelfUpdateCmd() *cobra.Command
- func NewSetUpCmd(f *flags.GlobalFlags) *cobra.Command
- func NewStatusCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewStopCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewTroubleshootCmd(flags *flags.GlobalFlags) *cobra.Command
- func NewUpgradeCmd(f *flags.GlobalFlags) *cobra.Command
- func NewVersionCmd() *cobra.Command
- type BuildCmd
- type DeleteCmd
- type DevsyProInstance
- type DownCmd
- type ExecCmd
- type ExportCmd
- type ImportCmd
- type ListCmd
- type LogsCmd
- type LogsDaemonCmd
- type OutdatedCmd
- type PingCmd
- type PrintableError
- type ReadConfigurationCmd
- type RenameCmd
- type RunUserCommandsCmd
- type SSHCmd
- type SelfUpdateCmd
- type SetUpCmd
- type StatusCmd
- type StopCmd
- type TroubleshootCmd
- type UpgradeCmd
- type VersionCmd
Constants ¶
const (
DisableSSHKeepAlive time.Duration = 0 * time.Second
)
Variables ¶
This section is empty.
Functions ¶
func Execute ¶
func Execute()
Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.
func NewBuildCmd ¶
func NewBuildCmd(flags *flags.GlobalFlags) *cobra.Command
NewBuildCmd creates a new command.
func NewDeleteCmd ¶
func NewDeleteCmd(flags *flags.GlobalFlags) *cobra.Command
NewDeleteCmd creates a new command.
func NewDownCmd ¶ added in v1.1.0
func NewDownCmd(flags *flags.GlobalFlags) *cobra.Command
NewDownCmd creates a new down command that stops and deletes a workspace.
func NewExecCmd ¶ added in v1.1.0
func NewExecCmd(f *flags.GlobalFlags) *cobra.Command
func NewExportCmd ¶
func NewExportCmd(flags *flags.GlobalFlags) *cobra.Command
NewExportCmd creates a new command.
func NewImportCmd ¶
func NewImportCmd(flags *flags.GlobalFlags) *cobra.Command
NewImportCmd creates a new command.
func NewListCmd ¶
func NewListCmd(flags *flags.GlobalFlags) *cobra.Command
NewListCmd creates a new destroy command.
func NewLogsCmd ¶
func NewLogsCmd(flags *flags.GlobalFlags) *cobra.Command
NewLogsCmd creates a new destroy command.
func NewLogsDaemonCmd ¶
func NewLogsDaemonCmd(flags *flags.GlobalFlags) *cobra.Command
NewLogsDaemonCmd creates a new destroy command.
func NewOutdatedCmd ¶ added in v1.1.0
func NewOutdatedCmd(f *flags.GlobalFlags) *cobra.Command
NewOutdatedCmd creates a new outdated command.
func NewPingCmd ¶
func NewPingCmd(flags *flags.GlobalFlags) *cobra.Command
func NewReadConfigurationCmd ¶ added in v1.1.0
func NewReadConfigurationCmd(f *flags.GlobalFlags) *cobra.Command
NewReadConfigurationCmd creates a new read-configuration command.
func NewRenameCmd ¶ added in v1.3.0
func NewRenameCmd(globalFlags *flags.GlobalFlags) *cobra.Command
NewRenameCmd creates a new command for renaming a workspace.
func NewRunUserCommandsCmd ¶ added in v1.1.0
func NewRunUserCommandsCmd(f *flags.GlobalFlags) *cobra.Command
NewRunUserCommandsCmd creates a new run-user-commands command.
func NewRunUserCommandsCmdAlias ¶ added in v1.1.0
func NewRunUserCommandsCmdAlias(f *flags.GlobalFlags) *cobra.Command
NewRunUserCommandsCmdAlias creates the hidden camelCase alias for devcontainer CLI compat.
func NewSSHCmd ¶
func NewSSHCmd(f *flags.GlobalFlags) *cobra.Command
NewSSHCmd creates a new ssh command.
func NewSelfUpdateCmd ¶ added in v1.1.0
NewSelfUpdateCmd creates a new self-update command.
func NewSetUpCmd ¶ added in v1.1.0
func NewSetUpCmd(f *flags.GlobalFlags) *cobra.Command
NewSetUpCmd creates a new set-up command.
func NewStatusCmd ¶
func NewStatusCmd(flags *flags.GlobalFlags) *cobra.Command
NewStatusCmd creates a new command.
func NewStopCmd ¶
func NewStopCmd(flags *flags.GlobalFlags) *cobra.Command
NewStopCmd creates a new destroy command.
func NewTroubleshootCmd ¶
func NewTroubleshootCmd(flags *flags.GlobalFlags) *cobra.Command
func NewUpgradeCmd ¶
func NewUpgradeCmd(f *flags.GlobalFlags) *cobra.Command
NewUpgradeCmd creates a new upgrade command.
func NewVersionCmd ¶
NewVersionCmd creates a new ws-tunnel command.
Types ¶
type BuildCmd ¶
type BuildCmd struct {
*flags.GlobalFlags
provider.CLIOptions
ProviderOptions []string
SkipDelete bool
Machine string
}
BuildCmd holds the cmd flags.
type DeleteCmd ¶
type DeleteCmd struct {
*flags.GlobalFlags
client2.DeleteOptions
}
DeleteCmd holds the delete cmd flags.
type DevsyProInstance ¶
type DownCmd ¶ added in v1.1.0
type DownCmd struct {
*flags.GlobalFlags
client2.DeleteOptions
}
DownCmd holds the down cmd flags.
type ExecCmd ¶ added in v1.1.0
type ImportCmd ¶
type ImportCmd struct {
*flags.GlobalFlags
WorkspaceID string
MachineID string
MachineReuse bool
ProviderID string
ProviderReuse bool
Data string
}
ImportCmd holds the export cmd flags.
type ListCmd ¶
type ListCmd struct {
*flags.GlobalFlags
Output string
SkipPro bool
}
ListCmd holds the configuration.
type LogsDaemonCmd ¶
type LogsDaemonCmd struct {
*flags.GlobalFlags
}
LogsDaemonCmd holds the configuration.
type OutdatedCmd ¶ added in v1.1.0
type OutdatedCmd struct {
*flags.GlobalFlags
WorkspaceFolder string
Config string
}
OutdatedCmd checks for newer versions of installed devcontainer features.
type PingCmd ¶
type PingCmd struct {
*flags.GlobalFlags
}
type PrintableError ¶
type PrintableError struct {
// contains filtered or unexported fields
}
(ThomasK33): Little type embedding here, so that we can serialize the error strings when invoking json.Marshal.
func (PrintableError) MarshalJSON ¶
func (p PrintableError) MarshalJSON() ([]byte, error)
type ReadConfigurationCmd ¶ added in v1.1.0
type ReadConfigurationCmd struct {
*flags.GlobalFlags
WorkspaceFolder string
Config string
ContainerID string
IDLabels []string
DockerPath string
IncludeFeaturesConfiguration bool
IncludeMergedConfiguration bool
}
ReadConfigurationCmd holds the read-configuration cmd flags.
type RenameCmd ¶ added in v1.3.0
type RenameCmd struct {
*flags.GlobalFlags
}
RenameCmd holds the rename cmd flags.
type RunUserCommandsCmd ¶ added in v1.1.0
type RunUserCommandsCmd struct {
*flags.GlobalFlags
WorkspaceFolder string
ContainerID string
DockerPath string
Config string
OverrideConfig string
RemoteEnv []string
IDLabels []string
Prebuild bool
SkipNonBlockingCommands bool
SkipPostCreate bool
SkipPostStart bool
SkipPostAttach bool
SkipOnCreate bool
SkipUpdateContent bool
}
RunUserCommandsCmd holds the run-user-commands command flags.
type SSHCmd ¶
type SSHCmd struct {
*flags.GlobalFlags
ForwardPortsTimeout string
ForwardPorts []string
ReverseForwardPorts []string
SendEnvVars []string
SetEnvVars []string
Stdio bool
JumpContainer bool
ReuseSSHAuthSock string
AgentForwarding bool
GPGAgentForwarding bool
GitSSHSignatureForwarding bool
GitSSHSigningKey string
// ssh keepalive options
SSHKeepAliveInterval time.Duration `json:"sshKeepAliveInterval,omitempty"`
StartServices bool
TermMode string
InstallTerminfo bool
Command string
User string
WorkDir string
}
SSHCmd holds the ssh cmd flags.
type SelfUpdateCmd ¶ added in v1.1.0
SelfUpdateCmd is a struct that defines a command call for "self-update".
type SetUpCmd ¶ added in v1.1.0
type SetUpCmd struct {
*flags.GlobalFlags
Container string
Config string
WorkspaceFolder string
DockerPath string
}
SetUpCmd holds the set-up command flags.
type StatusCmd ¶
type StatusCmd struct {
*flags.GlobalFlags
client2.StatusOptions
Output string
Timeout string
}
StatusCmd holds the cmd flags.
type StopCmd ¶
type StopCmd struct {
*flags.GlobalFlags
client2.StopOptions
}
StopCmd holds the destroy cmd flags.
type TroubleshootCmd ¶
type TroubleshootCmd struct {
*flags.GlobalFlags
}
type UpgradeCmd ¶
type UpgradeCmd struct {
*flags.GlobalFlags
WorkspaceFolder string
Config string
DryRun bool
}
UpgradeCmd upgrades devcontainer feature versions to the latest available.