Skip to content

Function: headlessReason()

headlessReason(env?, platform?): string | undefined

Defined in: packages/aiui-util/src/environment.ts:58

Why this environment is considered headless — a short human-readable fragment for messages like "detected a headless environment (<reason>)" — or undefined when a GUI is presumed available. The checks run most-explicit first (CI, then SSH, then the platform's display convention); see the module doc for the reasoning behind each signal.

Parameters

env?

ProcessEnv = process.env

platform?

Platform = process.platform

Returns

string | undefined