Sake - Golang本地与远程主机命令执行工具库

Sake 是一个用 Go 语言编写的工具库，用于在本地和远程主机上执行命令。它提供了简单易用的 API 来执行 shell 命令，并支持 SSH 连接远程主机执行命令。

安装

go get github.com/alexellis/sake

基本使用

1. 本地命令执行

package main

import (
	"fmt"
	"log"

	"github.com/alexellis/sake/pkg/exec"
)

func main() {
	// 执行本地命令
	cmd := exec.Command("ls", "-la")
	output, err := cmd.CombinedOutput()
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(string(output))
}

2. 远程SSH命令执行

package main

import (
	"fmt"
	"log"

	"github.com/alexellis/sake/pkg/ssh"
)

func main() {
	// 配置SSH客户端
	config := &ssh.Config{
		Host:     "example.com",
		Port:     22,
		User:     "username",
		Password: "password", // 或者使用 KeyPath 指定私钥路径
		// KeyPath: "/path/to/private/key",
	}

	// 创建SSH客户端
	client, err := ssh.NewClient(config)
	if err != nil {
		log.Fatal(err)
	}
	defer client.Close()

	// 执行远程命令
	output, err := client.Run("ls -la")
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(output)
}

高级功能

1. 批量执行命令

package main

import (
	"fmt"
	"log"

	"github.com/alexellis/sake/pkg/exec"
	"github.com/alexellis/sake/pkg/ssh"
)

func main() {
	// 定义多个主机
	hosts := []ssh.Config{
		{
			Host:     "server1.example.com",
			User:     "user1",
			Password: "pass1",
		},
		{
			Host:     "server2.example.com",
			User:     "user2",
			KeyPath:  "/path/to/key",
		},
	}

	// 并行在所有主机上执行命令
	results := make(chan string, len(hosts))
	for _, host := range hosts {
		go func(h ssh.Config) {
			client, err := ssh.NewClient(&h)
			if err != nil {
				results <- fmt.Sprintf("Error connecting to %s: %v", h.Host, err)
				return
			}
			defer client.Close()

			output, err := client.Run("uname -a")
			if err != nil {
				results <- fmt.Sprintf("Error on %s: %v", h.Host, err)
				return
			}

			results <- fmt.Sprintf("%s:\n%s", h.Host, output)
		}(host)
	}

	// 收集结果
	for i := 0; i < len(hosts); i++ {
		fmt.Println(<-results)
	}
}

2. 文件传输

package main

import (
	"log"

	"github.com/alexellis/sake/pkg/ssh"
)

func main() {
	config := &ssh.Config{
		Host:     "example.com",
		User:     "username",
		Password: "password",
	}

	client, err := ssh.NewClient(config)
	if err != nil {
		log.Fatal(err)
	}
	defer client.Close()

	// 上传文件
	err = client.Upload("/local/path/file.txt", "/remote/path/file.txt")
	if err != nil {
		log.Fatal(err)
	}

	// 下载文件
	err = client.Download("/remote/path/file.txt", "/local/path/downloaded.txt")
	if err != nil {
		log.Fatal(err)
	}
}

3. 交互式会话

package main

import (
	"log"
	"os"

	"github.com/alexellis/sake/pkg/ssh"
)

func main() {
	config := &ssh.Config{
		Host:     "example.com",
		User:     "username",
		Password: "password",
	}

	client, err := ssh.NewClient(config)
	if err != nil {
		log.Fatal(err)
	}
	defer client.Close()

	// 启动交互式shell
	err = client.Shell(os.Stdin, os.Stdout, os.Stderr)
	if err != nil {
		log.Fatal(err)
	}
}

最佳实践

1. 错误处理：始终检查错误并适当处理
2. 资源清理：确保关闭SSH连接
3. 并发控制：当批量执行时，使用sync.WaitGroup或通道控制并发
4. 安全：优先使用SSH密钥认证而非密码
5. 超时设置：为长时间运行的命令设置超时

// 带超时的命令执行示例
output, err := client.RunWithTimeout("long-running-command", 30*time.Second)

Sake 是一个轻量级但功能强大的库，适合需要自动化执行本地和远程命令的场景。它的API设计简洁，易于集成到现有的Go应用程序中。