https://github.com/creack/pty

PTY interface for Go
https://github.com/creack/pty

cross-platform go pty tty

Last synced: 5 days ago
JSON representation

PTY interface for Go

• Host: GitHub
• URL: https://github.com/creack/pty
• Owner: creack
• License: mit
• Created: 2011-05-03T21:25:23.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2024-08-13T20:49:06.000Z (5 months ago)
• Last Synced: 2024-10-29T19:58:51.263Z (2 months ago)
• Topics: cross-platform, go, pty, tty
• Language: Go
• Homepage: https://pkg.go.dev/github.com/creack/pty?tab=doc
• Size: 125 KB
• Stars: 1,694
• Watchers: 32
• Forks: 237
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• stars - creack/pty
• go-awesome - pty - PTY for Go (Open source library / Command Line)
• awesome-golang-repositories - pty

README

        
# pty

Pty is a Go package for using unix pseudo-terminals.

## Install

```sh

go get github.com/creack/pty

```

## Examples

Note that those examples are for demonstration purpose only, to showcase how to use the library. They are not meant to be used in any kind of production environment. If you want to **set deadlines to work** and `Close()` **interrupting** `Read()` on the returned `*os.File`, you will need to call `syscall.SetNonblock` manually.

### Command

```go

package main

import (

	"io"

	"os"

	"os/exec"

	"github.com/creack/pty"

)

func main() {

	c := exec.Command("grep", "--color=auto", "bar")

	f, err := pty.Start(c)

	if err != nil {

		panic(err)

	}

	go func() {

		f.Write([]byte("foo\n"))

		f.Write([]byte("bar\n"))

		f.Write([]byte("baz\n"))

		f.Write([]byte{4}) // EOT

	}()

	io.Copy(os.Stdout, f)

}

```

### Shell

```go

package main

import (

        "io"

        "log"

        "os"

        "os/exec"

        "os/signal"

        "syscall"

        "github.com/creack/pty"

        "golang.org/x/term"

)

func test() error {

        // Create arbitrary command.

        c := exec.Command("bash")

        // Start the command with a pty.

        ptmx, err := pty.Start(c)

        if err != nil {

                return err

        }

        // Make sure to close the pty at the end.

        defer func() { _ = ptmx.Close() }() // Best effort.

        // Handle pty size.

        ch := make(chan os.Signal, 1)

        signal.Notify(ch, syscall.SIGWINCH)

        go func() {

                for range ch {

                        if err := pty.InheritSize(os.Stdin, ptmx); err != nil {

                                log.Printf("error resizing pty: %s", err)

                        }

                }

        }()

        ch <- syscall.SIGWINCH // Initial resize.

        defer func() { signal.Stop(ch); close(ch) }() // Cleanup signals when done.

        // Set stdin in raw mode.

        oldState, err := term.MakeRaw(int(os.Stdin.Fd()))

        if err != nil {

                panic(err)

        }

        defer func() { _ = term.Restore(int(os.Stdin.Fd()), oldState) }() // Best effort.

        // Copy stdin to the pty and the pty to stdout.

        // NOTE: The goroutine will keep reading until the next keystroke before returning.

        go func() { _, _ = io.Copy(ptmx, os.Stdin) }()

        _, _ = io.Copy(os.Stdout, ptmx)

        return nil

}

func main() {

        if err := test(); err != nil {

                log.Fatal(err)

        }

}

```