Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Gaurav-Gosain/tuios/llms.txt

Use this file to discover all available pages before exploring further.

​
tuios

Run the TUIOS Terminal UI Operating System. 
tuios [flags]
TUIOS is a terminal-based window manager that provides a modern interface for managing multiple terminal sessions with workspace support, tiling modes, and comprehensive keyboard/mouse interactions.

​
Flags

FlagTypeDefaultDescription
--debugbooleanfalseEnable debug logging
--cpuprofilestring""Write CPU profile to file
--ascii-onlybooleanfalseUse ASCII characters instead of Nerd Font icons
--themestring""Color theme to use (e.g., dracula, nord, tokyonight). Leave empty to use standard terminal colors without theming
--list-themesbooleanfalseList all available themes and exit
--preview-themestring""Preview a theme’s 16 ANSI colors
--border-stylestring""Window border style: rounded, normal, thick, double, hidden, block, ascii, outer-half-block, inner-half-block (default: from config or rounded)
--dockbar-positionstring""Dockbar position: bottom, top, hidden (default: from config or bottom)
--hide-window-buttonsbooleanfalseHide window control buttons (minimize, maximize, close)
--scrollback-linesint0Number of lines to keep in scrollback buffer (default: from config or 10000, min: 100, max: 1000000)
--show-keysbooleanfalseEnable showkeys overlay to display pressed keys
--no-animationsbooleanfalseDisable UI animations for instant transitions
--window-title-positionstring""Window title position: bottom, top, hidden (default: from config or bottom)
--hide-clockbooleanfalseHide the clock overlay

​
Examples

# Run TUIOS with default settings
tuios

​
tuios ssh

Run TUIOS as an SSH server to allow remote connections. 
tuios ssh [flags]
Allows remote connections to TUIOS via SSH. The server will generate a host key automatically if not specified. By default, SSH sessions connect to the TUIOS daemon for persistent sessions. Session selection priority:
  1. --default-session flag (if specified)
  2. SSH username (if not generic like “tuios”, “root”, “anonymous”)
  3. SSH command argument (e.g., ssh host attach mysession)
  4. First available session or create new
Use --ephemeral for standalone sessions (legacy behavior).

​
Flags

FlagTypeDefaultDescription
--portstring"2222"SSH server port
--hoststring"localhost"SSH server host
--key-pathstring""Path to SSH host key (auto-generated if not specified)
--default-sessionstring""Default session name for all connections
--ephemeralbooleanfalseRun in ephemeral mode (standalone, no daemon)

​
Examples

# Start SSH server on default port 2222
tuios ssh

​
tuios daemon

Run the TUIOS daemon in the foreground. 
tuios daemon [flags]
This is useful for debugging. Normally the daemon runs in the background. The daemon manages persistent sessions and handles client connections.

​
Flags

FlagTypeDefaultDescription
--log-levelstring""Debug log level: off, errors, basic, messages, verbose, trace

​
Debug Log Levels

  • off - No debug output (default)
  • errors - Only error messages
  • basic - Connection events and errors
  • messages - All protocol messages except PTY I/O
  • verbose - All messages including PTY I/O
  • trace - Full payload hex dumps

​
Examples

# Run daemon in foreground
tuios daemon
The daemon starts automatically when you create or attach to a session, so you typically don’t need to run this command manually. Use it primarily for debugging purposes.

Build docs developers (and LLMs) love

Get started for freeTalk to us