Terminal

Terminal detection, colors, and formatting.

use tty

Check if standard streams are connected to a terminal (TTY) and get terminal dimensions. Useful for CLI tools that behave differently when piped vs interactive.

Example:

use tty
use term

fn main() {
    tty::is_stdout if {
        term::Green print
    }
    "PASS" print
    tty::is_stdout if {
        term::Reset print
    }
    nl
}

Functions

fn is_stdin

Check if stdin is connected to a terminal (TTY). Useful for detecting if input is from keyboard vs pipe.

Signature: ( -- is_tty:i64)

Example:

tty::is_stdin if { "Enter input: " print }

fn is_stdout

Check if stdout is connected to a terminal (TTY). Useful for disabling colors when output is piped.

Signature: ( -- is_tty:i64)

Example:

tty::is_stdout if { term::Green print }

fn is_stderr

Check if stderr is connected to a terminal (TTY).

Signature: ( -- is_tty:i64)

Example:

tty::is_stderr if { "interactive stderr" print nl }

fn width

Get terminal width in columns. Returns 0 if not a terminal or size cannot be determined.

Signature: ( -- cols:i64)

Example:

tty::width -> cols

fn height

Get terminal height in rows. Returns 0 if not a terminal or size cannot be determined.

Signature: ( -- rows:i64)

Example:

tty::height -> rows

fn size

Get terminal dimensions (rows and columns). Returns 0 for both values if not a terminal or size cannot be determined.

Signature: ( -- rows:i64 cols:i64)

Example:

tty::size -> cols -> rows

use term

ANSI escape codes for terminal colors and formatting.

Example:

term::Green print "PASS" print term::Reset print nl

Constants

Functions

fn fg256

Set foreground to 256-color palette value (0-255).

Signature: (n:i64 -- s:str)

Example:

196 term::fg256 print "Red" print term::Reset print nl

fn bg256

Set background to 256-color palette value (0-255).

Signature: (n:i64 -- s:str)

Example:

21 term::bg256 print "Blue BG" print term::Reset print nl

fn rgb

Set foreground to RGB color.

Signature: (r:i64 g:i64 b:i64 -- s:str)

Example:

255 128 0 term::rgb print "Orange" print term::Reset print nl

fn bg_rgb

Set background to RGB color.

Signature: (r:i64 g:i64 b:i64 -- s:str)

Example:

0 0 128 term::bg_rgb print "Navy BG" print term::Reset print nl

fn goto

Move cursor to specific position (1-indexed).

Signature: (row:i64 col:i64 -- s:str)

Example:

10 5 term::goto print

fn up

Move cursor up by n lines.

Signature: (n:i64 -- s:str)

fn down

Move cursor down by n lines.

Signature: (n:i64 -- s:str)

fn right

Move cursor right by n columns.

Signature: (n:i64 -- s:str)

fn left

Move cursor left by n columns.

Signature: (n:i64 -- s:str)