@blockchaincommons/components - v1.0.0-beta.4
    Preparing search index...

    Function connectToSshAgent

    • Connects to whatever socket $SSH_AUTH_SOCK points at, the reference's connect_to_ssh_agent.

      The agent returned opens one connection per request, so it holds no resource between calls and needs no closing. Identities whose key blob this package cannot parse (a certificate, a security key) are left out of listIdentities. As the reference's SSHAgent for its client, a failure once connected is an SshAgent error carrying the transport's message.

      Returns Promise<SshAgent>

      SshAgent SSH_AUTH_SOCK env var not set when the variable is unset; SshAgent no ssh-agent reachable when the socket cannot be connected.