terminal

README

Terminal

Terminal is a simple golang package that provides basic terminal handling.

Terminal wraps color/format functions provided by ANSI escape code

Usage

package main

import (
  "github.com/wsxiaoys/terminal"
  "github.com/wsxiaoys/terminal/color"
)

func main() {
  terminal.Stdout.Color("y").
    Print("Hello world").Nl().
    Reset().
    Colorf("@{kW}Hello world\n")

  color.Print("@rHello world")
}

Check the godoc result for more details.

Documentation

Index

• Variables
• type TerminalWriter
  • func (w *TerminalWriter) Clear() *TerminalWriter
  • func (w *TerminalWriter) ClearLine() *TerminalWriter
  • func (w *TerminalWriter) Color(syntax string) *TerminalWriter
  • func (w *TerminalWriter) Colorf(format string, a ...interface{}) *TerminalWriter
  • func (w *TerminalWriter) Down(x int) *TerminalWriter
  • func (w *TerminalWriter) Left(x int) *TerminalWriter
  • func (w *TerminalWriter) Move(x, y int) *TerminalWriter
  • func (w *TerminalWriter) Nl(a ...interface{}) *TerminalWriter
  • func (w *TerminalWriter) Print(a ...interface{}) *TerminalWriter
  • func (w *TerminalWriter) Reset() *TerminalWriter
  • func (w *TerminalWriter) Right(x int) *TerminalWriter
  • func (w *TerminalWriter) Up(x int) *TerminalWriter

Variables

var (
	Stdout = &TerminalWriter{os.Stdout}
	Stderr = &TerminalWriter{os.Stderr}
)

Types

type TerminalWriter

type TerminalWriter struct {
	io.Writer
}

func (*TerminalWriter) Clear

func (w *TerminalWriter) Clear() *TerminalWriter

func (*TerminalWriter) ClearLine

func (w *TerminalWriter) ClearLine() *TerminalWriter

func (*TerminalWriter) Color

func (w *TerminalWriter) Color(syntax string) *TerminalWriter

func (*TerminalWriter) Colorf

func (w *TerminalWriter) Colorf(format string, a ...interface{}) *TerminalWriter

func (*TerminalWriter) Down

func (w *TerminalWriter) Down(x int) *TerminalWriter

func (*TerminalWriter) Left

func (w *TerminalWriter) Left(x int) *TerminalWriter

func (*TerminalWriter) Move

func (w *TerminalWriter) Move(x, y int) *TerminalWriter

func (*TerminalWriter) Nl

func (w *TerminalWriter) Nl(a ...interface{}) *TerminalWriter

func (*TerminalWriter) Print

func (w *TerminalWriter) Print(a ...interface{}) *TerminalWriter

func (*TerminalWriter) Reset

func (w *TerminalWriter) Reset() *TerminalWriter

func (*TerminalWriter) Right

func (w *TerminalWriter) Right(x int) *TerminalWriter

func (*TerminalWriter) Up

func (w *TerminalWriter) Up(x int) *TerminalWriter