Skip to content

Interface ShellState ​

Source: shell.ts

The internal reactive state of the shell.

Properties ​

history ​

history: HistoryEntry[]

An array of all past outputs and commands displayed in the terminal.


line ​

line: string

The current, unsubmitted text in the input line.


historyOffset ​

historyOffset: number

Current position in the history search (0 is the current line).


workingDirectory ​

workingDirectory: VirtualFolder

The current directory the shell is operating within.


prompt ​

prompt: string

The formatted prompt string (e.g., "user@host:~$ ").


stream ​

stream: Stream<string> | null

The current active input stream for a running process.


ttyBuffer ​

ttyBuffer: string | null

Temporary storage for data written to the terminal while a stream is active.


isUsingAltScreen ​

isUsingAltScreen: boolean

Indicates if a process has requested the Alternate Screen Buffer (e.g., a text editor).


env ​

env: Record<string, string>

A reactive view of the current environment variables.


isRawMode ​

isRawMode: boolean

Indicates whether the shell is currently in raw mode, forwarding all keystrokes directly to the active stream.


cursorPosition ​

cursorPosition: Vector2

The position of the cursor in raw mode.

Built by Prozilla