GitHub

terminal_capabilities

API reference for terminal_capabilities.

What the terminal running the CLI can do (Effect's TerminalCapabilities): color output, animation and interactive prompts.

The TerminalCapabilities reference defaults to the process's own streams and environment; layer reads them through Stdio and the current ConfigProvider instead, so tests can pick them::

caps = yield from TerminalCapabilities()
if caps.can_prompt: ...

TERM=dumb turns everything off; NO_COLOR (non-empty) turns color off; FORCE_COLOR (non-empty, not 0 or false) turns it on without a terminal.

Values

AttributeTypeDescription
layerLayer[Never, Never, Stdio]

Capabilities read from Stdio and the NO_COLOR, FORCE_COLOR and TERM config keys.

Classes

Functions

detect

detect(*, no_color, force_color, term, stdin_is_terminal, stdout_is_terminal) -> Capabilities
ParameterTypeDescription
no_colorstr | None
force_colorstr | None
termstr | None
stdin_is_terminalbool
stdout_is_terminalbool

Returns Capabilities

def detect(
    *,
    no_color: str | None,
    force_color: str | None,
    term: str | None,
    stdin_is_terminal: bool,
    stdout_is_terminal: bool,
) -> Capabilities:
    if term == "dumb":
        return Capabilities(can_color=False, can_animate=False, can_prompt=False)
    return Capabilities(
        can_color=not _present(no_color) and (_forcing(force_color) or stdout_is_terminal),
        can_animate=stdout_is_terminal,
        can_prompt=stdin_is_terminal and stdout_is_terminal,
    )

from_process

from_process() -> Capabilities

The capabilities of this process's standard streams and environment.

Returns Capabilities

def from_process() -> Capabilities:
    """The capabilities of this process's standard streams and environment."""
    return detect(
        no_color=os.environ.get("NO_COLOR"),
        force_color=os.environ.get("FORCE_COLOR"),
        term=os.environ.get("TERM"),
        stdin_is_terminal=_isatty(sys.stdin),
        stdout_is_terminal=_isatty(sys.stdout),
    )