agent

package

v2.0.0-beta.2 Latest Latest Go to latest Published: Jun 9, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/k0sproject/rig

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package agent provides a client implementation for the SSH agent.

Index ¶

Variables
func NewClient() (agent.Agent, io.Closer, error)
func NewClientFromSocket(socketPath string) (agent.Agent, io.Closer, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrSSHAgent = errors.New("connect ssh agent")

ErrSSHAgent is returned when connection to SSH agent fails.

Functions ¶

func NewClient ¶

func NewClient() (agent.Agent, io.Closer, error)

NewClient returns an SSH agent and its underlying closer if a socket address is defined in SSH_AUTH_SOCK. The caller must close the returned io.Closer when done.

func NewClientFromSocket ¶

func NewClientFromSocket(socketPath string) (agent.Agent, io.Closer, error)

NewClientFromSocket returns an SSH agent and its underlying closer using the provided socket path. The caller must close the returned io.Closer when done.

Types ¶

This section is empty.

Source Files ¶

View all Source files

agent.go

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