package
18.0.0-dev.vnet-windows.4+incompatible
Repository: https://github.com/gravitational/teleport.git
Documentation: pkg.go.dev

# Functions

BaseConfigWithMutators returns a base bot config with the given CLI mutators applied.
LoadConfigWithMutators builds a config from an optional config file and a CLI mutator.
NewApplicationCommand initializes a command and flag for application outputs and returns a struct that will contain the parse result.
NewApplicationTunnelCommand initializes flags for an app tunnel command and returns a struct to contain the parse result.
NewDatabaseCommand initializes a command and flags for database outputs and returns a struct that will contain the parse result.
NewDatabaseTunnelCommand creates a command supporting `tbot start database-tunnel`.
NewDBCommand initializes flags for `tbot db`.
NewGlobalArgs appends global flags to the application and returns a struct that will be populated at parse time.
NewGlobalArgsWithStaticConfig creates a new GlobalArgs instance with a static YAML config.
NewIdentityCommand initializes the command and flags for identity outputs and returns a struct that will contain the parse result.
NewInitCommand constructs an InitCommand at the top level of the given application.
NewKubeCredentialsCommand initializes a kubernetes `credentials` command and returns a struct that will contain the parse result.
NewKubernetesCommand initializes the command and flags for kubernetes outputs and returns a struct to contain the parse result.
NewKubernetesCommand initializes the command and flags for kubernetes outputs and returns a struct to contain the parse result.
NewLegacyCommand initializes and returns a command supporting `tbot start legacy` and `tbot configure legacy`.
NewMigrateCommand initializes the `tbot migrate` command and its flags.
NewProxyCommand initializes the subcommand for `tbot proxy`.
NewSPIFFESVIDCommand initializes the command and flags for the `spiffe-svid` output and returns a struct that will contain the parse result.
NewSSHMultiplexerProxyCommand initializes and parses args for `tbot ssh-multiplexer-proxy-command`.
NewSSHProxyCommand initializes the `tbot ssh-proxy-command` subcommand and its fields.
NewStaticAuthServer returns an AuthProxyArgs with the given AuthServer field configured.
NewWorkloadIdentityAPICommand initializes the command and flags for the `workload-identity-api` service and returns a struct that will contain the parse result.
NewWorkloadIdentityJWTCommand initializes the command and flags for the `workload-identity-jwt` output and returns a struct that will contain the parse result.
NewWorkloadIdentityX509Command initializes the command and flags for the `workload-identity-x509` output and returns a struct that will contain the parse result.
RemainingArgs returns a list of remaining arguments for the given command.

# Constants

AuthServerEnvVar is the environment variable that overrides the configured auth server address.
CommandModeConfigure indicates a command instance will be used for `tbot configure ...`.
CommandModeStart indicates a command instance will be used for `tbot start ...`.
ProxyServerEnvVar is the environment variable that overrides the configured proxy server address.
TokenEnvVar is the environment variable that overrides the configured bot token name.

# Structs

ApplicationCommand implements `tbot start application` and `tbot configure application`.
ApplicationTunnelCommand implements `tbot start application-tunnel` and `tbot configure application-tunnel`.
AuthProxyArgs is an embeddable struct that can add --auth-server and --proxy-server to arbitrary commands for reuse.
DatabaseCommand implements `tbot start database` and `tbot configure database`.
DatabaseTunnelCommand implements `tbot start database-tunnel` and `tbot configure database-tunnel`.
DBCommand contains fields for `tbot db`.
GlobalArgs is a set of arguments additionally passed to all command handlers.
IdentityCommand implements `tbot start identity` and `tbot configure identity`.
InitCommand implements a command for `tbot init`.
No description provided by the author
KubernetesCommand implements `tbot start kubernetes` and `tbot configure kubernetes`.
KubernetesV2Command implements `tbot start kubernetes` and `tbot configure kubernetes`.
LegacyCommand starts with legacy behavior.
LegacyDestinationDirArgs is an embeddable struct that provides legacy-style --destination-dir handling, largely for reuse by `start legacy` and other older subcommands like `init`.
MigrateCommand contains fields parsed for `tbot migrate`.
ProxyCommand supports `tbot proxy`.
SPIFFESVIDCommand implements `tbot start spiffe-svid` and `tbot configure spiffe-svid`.
SSHMultiplexerProxyCommand includes fields for `tbot ssh-multiplexer-proxy-command`.
SSHProxyCommand includes fields for `tbot ssh-proxy-command`.
WorkloadIdentityAPICommand implements `tbot start workload-identity-api` and `tbot configure workload-identity-api`.
WorkloadIdentityJWTCommand implements `tbot start workload-identity-jwt` and `tbot configure workload-identity-jwt`.
WorkloadIdentityX509Command implements `tbot start workload-identity-x509` and `tbot configure spiffe-svid`.

# Interfaces

CommandRunner defines a contract for `TryRun` that allows commands to either execute (possibly returning an error), or pass execution to the next command candidate.
ConfigMutator is an interface that can apply changes to a BotConfig.
KingpinClause allows commands and flags to mount to either the root app (kingpin.Application) or a subcommand (kingpin.CmdClause).

# Type aliases

CommandMode is a simple enum to help shared start/configure command substitute the correct verb based on whether they are being used for "start" or "configure" actions.
MutatorAction is an action that is called by a config mutator-style command.
RemainingArgsList is a custom kingpin parser that consumes all remaining arguments.