Struct Tui 

pub struct Tui {

    pub notification_settings: TuiNotificationSettings,
    pub animations: bool,
    pub show_tooltips: bool,
    pub vim_mode_default: bool,
    pub raw_output_mode: bool,
    pub alternate_screen: AltScreenMode,
    pub status_line: Option<Vec<String>>,
    pub status_line_use_colors: bool,
    pub terminal_title: Option<Vec<String>>,
    pub theme: Option<String>,
    pub pet: Option<String>,
    pub pet_anchor: TuiPetAnchor,
    pub session_picker_view: Option<SessionPickerViewMode>,
    pub resume_cwd: Option<ResumeCwdMode>,
    pub keymap: TuiKeymap,
    pub model_availability_nux: ModelAvailabilityNuxConfig,
    pub terminal_resize_reflow_max_rows: Option<usize>,
}

Collection of settings that are specific to the TUI.

Fields

notification_settings: TuiNotificationSettings

animations: bool

Enable animations (welcome screen, shimmer effects, spinners). Defaults to true.

show_tooltips: bool

Show startup tooltips in the TUI welcome screen. Defaults to true.

vim_mode_default: bool

Start the composer in Vim mode (Normal) by default. Defaults to false.

raw_output_mode: bool

Start the TUI in raw scrollback mode for copy-friendly transcript output. Defaults to false.

alternate_screen: AltScreenMode

Controls whether the TUI uses the terminal’s alternate screen buffer.

• auto (default): Use alternate screen.
• always: Always use alternate screen.
• never: Never use alternate screen (inline mode only, preserves scrollback).

status_line: Option<Vec<String>>

Ordered list of status line item identifiers.

When set, the TUI renders the selected items as the status line. When unset, the TUI defaults to: model-with-reasoning and current-dir.

status_line_use_colors: bool

Color status line items with colors derived from the active syntax theme. Defaults to true.

terminal_title: Option<Vec<String>>

Ordered list of terminal title item identifiers.

When set, the TUI renders the selected items into the terminal window/tab title. When unset, the TUI defaults to: activity and project. The activity item spins while working and shows an action-required message when blocked on the user.

theme: Option<String>

Syntax highlighting theme name (kebab-case).

When set, overrides automatic light/dark theme detection. Use /theme in the TUI or see $CODEX_HOME/themes for custom themes.

pet: Option<String>

Pet id to preselect in the terminal pet picker.

Custom pet ids resolve against CODEX_HOME/pets//pet.json.

pet_anchor: TuiPetAnchor

Where the terminal pet should anchor vertically.

Defaults to composer, which follows the current TUI composer viewport.

session_picker_view: Option<SessionPickerViewMode>

Preferred layout for resume/fork session picker results.

resume_cwd: Option<ResumeCwdMode>

Working directory to use when resuming or forking a session. When unset, prompt if the current and session directories differ.

keymap: TuiKeymap

Keybinding overrides for the TUI.

This supports rebinding selected actions globally and by context. Context bindings take precedence over global bindings.

model_availability_nux: ModelAvailabilityNuxConfig

Startup tooltip availability NUX state persisted by the TUI.

terminal_resize_reflow_max_rows: Option<usize>

Trim terminal resize-reflow replay to the most recent rendered terminal rows when the transcript exceeds this cap. Omit to use Codex’s terminal-specific default. Set to 0 to keep all rendered rows.

Trait Implementations

impl Clone for Tui

fn clone(&self) -> Tui

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tui

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Tui

fn default() -> Tui

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tui

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Tui

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Tui

fn eq(&self, other: &Tui) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Tui

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tui