forked from Selig/openclaw-skill
6 custom skills (assign-task, dispatch-webhook, daily-briefing, task-capture, qmd-brain, tts-voice) with technical documentation. Compatible with Claude Code, OpenClaw, Codex CLI, and OpenCode.
31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
# TUI Documentation
|
|
|
|
## Overview
|
|
The Terminal UI (TUI) is an interface for interacting with the OpenClaw Gateway. It provides real-time chat capabilities with agents, including message delivery, session management, and tool execution.
|
|
|
|
## Key Components
|
|
|
|
**Interface Elements:**
|
|
The TUI displays a connection header, chat history with messages and system notices, status indicators, and an input editor with autocomplete functionality.
|
|
|
|
**Core Concepts:**
|
|
The system uses agents (unique identifiers like "main" or "research") and sessions that belong to specific agents. Sessions can operate in "per-sender" mode (multiple sessions per agent) or "global" mode (single shared session).
|
|
|
|
## Essential Features
|
|
|
|
**Keyboard Navigation:**
|
|
Common shortcuts include Enter to send, Escape to abort, Ctrl+L for model selection, Ctrl+G for agent switching, and Ctrl+P for session management.
|
|
|
|
**Slash Commands:**
|
|
Users can control behavior through commands like `/think`, `/verbose`, `/reasoning`, and `/deliver` to adjust session parameters and message handling.
|
|
|
|
**Local Execution:**
|
|
Commands prefixed with `!` execute locally on the TUI host after initial permission, running in a fresh shell within the working directory.
|
|
|
|
## Setup & Connection
|
|
|
|
Start the Gateway with `openclaw gateway`, then launch the TUI with `openclaw tui`. For remote access, use connection parameters: `--url`, `--token`, and optionally `--password`.
|
|
|
|
**Default Behavior:**
|
|
Message delivery to providers is disabled by default and must be explicitly enabled through settings or the `--deliver` flag.
|