Versions in this module Expand all Collapse all v0 v0.2.0 Feb 10, 2026 Changes in this version type Flags + func (f *Flags) ExtractConfig(args []string, opts ...ValidateOption) (*ConnectionConfig, error) v0.1.0 Feb 9, 2026 Changes in this version + const AgentPrivateKeysEnv + const AskBastionPasswordEnv + const AskSudoPasswordEnv + const BastionHostEnv + const BastionPortEnv + const BastionUserEnv + const ConnectionConfigEnv + const DefaultPort + const ExtraArgsEnv + const ForceNoPrivateKeysEnv + const HostsEnv + const LegacyModeEnv + const ModernModeEnv + const PortEnv + const UseAgentWithNoPrivateKeysEnv + const UserEnv + var ErrValidationRuleFailed = fmt.Errorf("validation rule failed") + func ConfigurationOpenAPISpec() string + func HostOpenAPISpec() string + type AgentPrivateKey struct + IsPath bool + Key string + Passphrase string + type AskPasswordFunc func(promt string) ([]byte, error) + type Config struct + BastionHost string + BastionPassword string + BastionPort *int + BastionUser string + ExtraArgs string + ForceUseSSHAgent bool + Port *int + PrivateKeys []AgentPrivateKey + SudoPassword string + User string + func (c *Config) BastionPortString() string + func (c *Config) Clone() *Config + func (c *Config) FillDefaults() *Config + func (c *Config) HaveAuthMethods() bool + func (c *Config) PortString() string + type ConnectionConfig struct + Config *Config + Hosts []Host + func ParseConnectionConfig(reader io.Reader, sett settings.Settings, opts ...ValidateOption) (*ConnectionConfig, error) + type Flags struct + AskBastionPass bool + AskSudoPass bool + BastionHost string + BastionPort int + BastionUser string + ConnectionConfigPath string + ExtraArgs string + Hosts []string + Port int + PrivateKeysPaths []string + User string + func (f *Flags) FillDefaults() error + func (f *Flags) FlagSet() (*flag.FlagSet, error) + func (f *Flags) IsConflictBetweenFlags() error + func (f *Flags) Parse(args []string) error + func (f *Flags) RewriteFromEnvs() error + type FlagsParser struct + func NewFlagsParser(sett settings.Settings) *FlagsParser + func (p *FlagsParser) ExtractConfigAfterParse(flags *Flags, opts ...ValidateOption) (*ConnectionConfig, error) + func (p *FlagsParser) InitFlags(set *flag.FlagSet) (*Flags, error) + func (p *FlagsParser) ParseFlagsAndExtractConfig(arguments []string, set *flag.FlagSet, opts ...ValidateOption) (*ConnectionConfig, error) + func (p *FlagsParser) WithAsk(ask AskPasswordFunc) *FlagsParser + func (p *FlagsParser) WithPrivateKeyPasswordExtractor(extractor PrivateKeyExtractorFunc) *FlagsParser + type Host struct + Host string + type Mode struct + ForceLegacy bool + ForceModern bool + type PrivateKeyExtractorFunc func(path string, logger log.Logger) (password string, err error) + type ValidateOption func(o *validateOptions) + func ParseWithNoPrettyError(v bool) ValidateOption + func ParseWithOmitDocInError(v bool) ValidateOption + func ParseWithRequiredSSHHost(v bool) ValidateOption + func ParseWithSkipUnknownKinds(v bool) ValidateOption + func ParseWithStrictUnmarshal(v bool) ValidateOption
Go to main page