Skip to content

terminal.viewport.read.v1

Read terminal viewport

Returns one bounded observation of the visible terminal identified by invocation scope.

At a glance

Callable byagent, cli, plugin
Effectread — Reads state and changes nothing.
Confirmationnever — Runs without asking.
Idempotencynone
Leaves the machineno
Provided bydev.tenon.core
Contract classsealed

Input

Takes no properties — send {}.

Output

PropertyRequiredTypeConstraints
columnsyesinteger | null
exitedyesboolean
paneIDyesstringformat uuid, length 36–36, pattern-checked
rowsyesinteger | null
textyesstringlength 0–49152

Errors it can return

These are this contract’s own failures, on top of the lifecycle errors every intent can settle with. See Errors.

  • dev.tenon.core.terminal-unavailable

Call it

From a plugin — declare it in intents.uses first:

js
const result = await tenon.intents.send("terminal.viewport.read.v1", {})
if (!result.ok) throw new Error(result.error.code)

From a shell:

sh
tenon-cli intent send terminal.viewport.read.v1 --input '{}'

Ask your own build for this same contract with tenon-cli intent describe terminal.viewport.read.v1.