# roundel/terminal

> Every export of roundel/terminal, with its signature and doc comment: unicode, AGENTS, interactive, plus 2 types.

Source: https://roundel.interlace.tools/docs/api/terminal

<!-- Generated by scripts/api-reference.ts from the built dist/*.d.ts. Do not edit; run `npx tsx scripts/api-reference.ts`. -->

Two questions about the terminal that are not colour, and that three packages in the family
were each answering by hand (R12).

- **Is anybody there to type?** `caique/decide` asked `isTTY.stdin && !CI` and missed the
  agent case entirely: under Claude Code a prompt has a terminal and no person, and a
  prompt that waits there hangs the agent that ran it. burgee's own `detectAgent` knew
  that; caique did not ask it.
- **Can it draw a tick?** `flagstaff/ora` carried is-unicode-supported whole, and
  `caique/inquirer` a four-condition subset that answered differently on the Linux console
  and on half the Windows terminals the full table names.

Both read a runtime passed in, never the process (R9), and neither reaches another module,
so `roundel/terminal` costs only itself. It is its own subpath rather than more of
`roundel/policy` because `./chalk` stands on `policy.js` and R8 caps that whole graph at
chalk 6.0.0's own bytes, with 7 of them to spare.

```ts
import { unicode, AGENTS, interactive } from 'roundel/terminal';
```

## Functions

### unicode

Whether the terminal can be expected to draw non-ASCII glyphs — is-unicode-supported 2.1.0,
condition for condition. Everything but Windows is yes, except the Linux console
(`TERM=linux`), whose font has no ticks; on Windows only the terminals the incumbent names.

This is the one place roundel reads `TERM_PROGRAM` and the platform. The refusal in the
spec is about *colour* — the level is decided by the user's instruction and `TERM`, never an
emulator allow-list — and a glyph table is not a colour level.

```ts
function unicode({ env, platform }: Glyphs): boolean;
```

| Parameter | Type |
| :-- | :-- |
| `{ env, platform }` | `Glyphs` |

**Returns** `boolean`

## Constants

### AGENTS

The variables whose presence says an agent is driving the process — the list
`burgee/src/agent.ts` probes (N12), after `@vercel/detect-agent`. `AI_AGENT` is the generic
one any agent can set.

```ts
const AGENTS: readonly ["AI_AGENT", "CLAUDECODE", "CURSOR_AGENT", "CODEX_THREAD_ID", "GEMINI_CLI"];
```

### interactive

Whether a person can be asked something and be expected to answer.

`FORCE_TTY=1` says yes outright, as it does to burgee's `detectAgent`: it is the one
explicit instruction, and a caller who pipes answers into a prompt on purpose sets it.
Otherwise it takes a terminal on stdin, no `CI`, and no agent variable. An agent may well
have a terminal; what it does not have is a person.

```ts
const interactive: ({ env, isTTY }: Terminal) => boolean;
```

## Interfaces

### Glyphs

The slice `unicode` reads: the environment and the platform, `process.platform`'s spelling.

```ts
interface Glyphs {
    env: Record<string, string | undefined>;
    platform?: string;
}
```

### Terminal

The slice of a runtime `interactive` reads. burgee's and caique's runtimes both satisfy it.

```ts
interface Terminal {
    env: Record<string, string | undefined>;
    isTTY: {
        stdin: boolean;
    };
}
```