console

Documentation

Overview

Package console contains utility functions for working with text consoles

Index

• Variables
• func Ask(prompt string) string
• func Clear(content string)
• func ClearLine()
• func Confirm(defaultYes bool, prompt string) bool

Variables

var HasColour bool

HasColour is true if your program is running a platform that supports ANSI colours

var IsTTY bool

IsTTY will be true if stdout is connected to a true terminal

Functions

func Ask

func Ask(prompt string) string

Ask prints the supplied prompt and then waits for user input which is returned as a string.

func Clear

func Clear(content string)

Clear removes all text from the console and puts the cursor in the top-left corner

func ClearLine

func ClearLine()

ClearLine removes all text from the current line and puts the cursor on the left

func Confirm

func Confirm(defaultYes bool, prompt string) bool

Confirm asks the user for "y" or "n" and returns true if the response was "y". defaultYes is used to determine whether (y/N) or (Y/n) is displayed after the prompt.