stdin

Documentation

Overview

Package stdin provides simple utilities for reading from stdin, as well as determining if stdin is a terminal or if something has been piped to it.

Index

• func HasInput() bool
• func IsInteractive() bool
• func IsPiped() bool
• func MaybePiped() (bool, error)
• func Read() (string, error)
• func ReadAll() (data string, read bool, err error)

Functions

func HasInput

func HasInput() bool

HasInput reports true when stdin is **not** a terminal. This covers pipes (echo foo | app), file redirects (app < file), and CI/dev‑null situations. It never blocks.

func IsInteractive

func IsInteractive() bool

IsInteractive reports whether the program is attached to a real terminal.

func IsPiped

func IsPiped() bool

IsPiped checks if something has been piped to stdin.

func MaybePiped

func MaybePiped() (bool, error)

MaybePiped checks if something has been piped to stdin.

func Read

func Read() (string, error)

Read returns stdin as a string, trimming the trailing newline.

func ReadAll

func ReadAll() (data string, read bool, err error)

ReadAll consumes stdin and returns the trimmed string plus a flag that tells whether any bytes were actually read.