osc52

README

go-osc52

A terminal Go library to copy text to clipboard from anywhere. It does so using ANSI OSC52. The Copy() function defaults to copying text from terminals running locally.

To use this over SSH, using gliderlabs/ssh, use NewOutput(sshSession, sshSession.Environ()) and make sure you pass the TERM environment variable in your SSH connection.

ssh -o SendEnv=TERM <host>

Tmux users need to pass an additional environment variable TMUX.

ssh -o SendEnv=TERM -o SendEnv=TMUX <host>

Credits

• vim-oscyank this is heavily inspired by vim-oscyank.

Documentation

Index

• func Copy(str string)
• type Output
  • func NewOutput(out io.Writer, envs []string) *Output
  • func (o *Output) Copy(str string)

Functions

func Copy

func Copy(str string)

Copy copies the OSC52 string to the output. This is the default copy function.

Types

type Output

type Output struct {
	// contains filtered or unexported fields
}

Output is where the OSC52 string should be written.

func NewOutput

func NewOutput(out io.Writer, envs []string) *Output

NewOutput returns a new Output.

func (*Output) Copy

func (o *Output) Copy(str string)

Copy copies the OSC52 string to the output.