Golang SSH Client.

Fast and easy golang ssh client module.

Installation ❘ Features ❘ Usage ❘ Examples ❘ License

Installation

go get github.com/melbahja/goph

Features

• Easy to use.
• Supports known hosts by default.
• Supports connections with passwords.
• Supports connections with private keys.
• Supports connections with protected private keys with passphrase.
• Supports upload files from local to remote.
• Supports download files from remote to local.
• Supports connections with ssh agent (Unix systems only).

Usage

Run a command via ssh:

package main

import (
	"log"
	"fmt"
	"github.com/melbahja/goph"
)

func main() {

	// Start new ssh connection with private key.
	client, err := goph.New("root", "192.1.1.3", goph.Key("/home/mohamed/.ssh/id_rsa", ""))

	if err != nil {
		log.Fatal(err)
	}

	// Defer closing the network connection. 
	defer client.Close()

	// Execute your command.
	out, err := client.Run("ls /tmp/")

	if err != nil {
		log.Fatal(err)
	}

	// Get your output as []byte.
	fmt.Println(string(out))
}

Start connection with protected private key:

client, err := goph.New("root", "192.1.1.3", goph.Key("/home/mohamed/.ssh/id_rsa", "you_passphrase_here"))

Start connection with password:

client, err := goph.New("root", "192.1.1.3", goph.Password("you_password_here"))

Start connection with ssh agent (Unix systems only):

client, err := goph.New("root", "192.1.1.3", goph.UseAgent())

Upload local file to remote:

err := client.Upload("/path/to/local/file", "/path/to/remote/file")

Download remote file to local:

err := client.Download("/path/to/remote/file", "/path/to/local/file")

Execute bash commands:

out, err := client.Run("bash -c 'printenv'")

Execute bash command with env variables:

out, err := client.Run(`env MYVAR="MY VALUE" bash -c 'echo $MYVAR;'`)

For more read the go docs.

Examples

See Examples.

License

Goph is provided under the MIT License.