Goph is a lightweight Go SSH client focusing on simplicity!

🚀  Installation and Documentation

go get github.com/melbahja/goph

🤘  Features

📄  Usage

package mainimport ("log""fmt""github.com/melbahja/goph")funcmain() {// Start new ssh connection with private key.auth,err:=goph.Key("/home/mohamed/.ssh/id_rsa","")iferr!=nil {log.Fatal(err)}client,err:=goph.New("root","192.1.1.3",auth)iferr!=nil {log.Fatal(err)}// Defer closing the network connection.deferclient.Close()// Execute your command.out,err:=client.Run("ls /tmp/")iferr!=nil {log.Fatal(err)}// Get your output as []byte.fmt.Println(string(out))}

🔐 Start Connection With Protected Private Key:

auth,err:=goph.Key("/home/mohamed/.ssh/id_rsa","you_passphrase_here")iferr!=nil {// handle error}client,err:=goph.New("root","192.1.1.3",auth)

🔑 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):

auth,err:=goph.UseAgent()iferr!=nil {// handle error}client,err:=goph.New("root","192.1.1.3",auth)

⤴️ 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 timeout:

context,cancel:=context.WithTimeout(ctx,time.Second)defercancel()// will send SIGINT and return error after 1 secondout,err:=client.RunContext(ctx,"sleep 5")

☛ Execute Bash Command With Env Variables:

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

🥪 Using Goph Cmd:

// Get new `Goph.Cmd`cmd,err:=client.Command("ls","-alh","/tmp")// or with context:// cmd, err := client.CommandContext(ctx, "ls", "-alh", "/tmp")iferr!=nil {// handle the error!}// You can set env vars, but the server must be configured to `AcceptEnv line`.cmd.Env= []string{"MY_VAR=MYVALUE"}// Run you command.err=cmd.Run()

📂 File System Operations Via SFTP:

sftp,err:=client.NewSftp()iferr!=nil {// handle the error!}file,err:=sftp.Create("/tmp/remote_file")file.Write([]byte(`Hello world`))file.Close()

🥙  Examples

🤝  Missing a Feature?

📘  License