Welcome to Gnetcli

The ultimate solution for CLI automation in Golang. It provides a universal way to execute arbitrary commands using a CLI, eliminating the need for screen scraping with expect. The project consist of go-library, GRPC-server and CLI-tool. It is typically used for automating network equipment such as Cisco, Juniper, Huawei, etc.

Feature Overview:

• Execute commands instead of just reading and writing.
• Pager, questions and error handling are supported.
  Describe CLI interface in a few expressions and get full power of the project.
• The project supports several network vendors, including Huawei, Juniper, Cisco, and RouterOS.
• Netconf is supported.
  Exec netconf in same manner as text command to simplify automation workflow.
• SSH tunneling is supported.
• Clean output
  Evaluation of terminal control codes and removal of echoes.
• CLI and GRPC-server for interacting with non-Go projects and other automations.

Install:

go get -u github.com/annetutil/gnetcli

Short example:

func main() {
    ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
    defer cancel()
    logger := zap.Must(zap.NewDevelopmentConfig().Build())
    creds := dcreds.NewSimpleCredentials(
        credentials.WithUsername(dcreds.GetLogin()),
        credentials.WithPassword(dcreds.Secret("mypassword")), // and password
    )
    connector := ssh.NewStreamer("myhost.domain", creds, ssh.WithLogger(logger))
    dev := huawei.NewDevice(connector) // huawei CLI upon SSH
    err := dev.Connect(ctx)            // connection happens here
    if err != nil{
        panic(err)
    }
    defer dev.Close()
    res, _ := dev.Execute(cmd.NewCmd("display interfaces"))
    fmt.Printf("Status: %d\nError: %s\nStatus: %d\n", res.Status(), res.Output(), res.Error())
}