TUI Commands
CLI commands for PraisonAI TUI
Slash commands and CLI flags control models, sessions, and layout inside the TUI.
from praisonaiagents import Agent
agent = Agent(name="tui-assistant", instructions="Use TUI slash commands effectively.")
agent.start("Which /model should I pick for fast replies?")The user types slash commands such as /help and /model while the agent streams responses in the TUI.
TUI CLI Commands
Complete reference for all TUI-related CLI commands.
Quick Start
- Launch the TUI
bash praisonai tui launch --model gpt-4 - Run a headless simulation
bash praisonai tui simulate test_script.yaml --assert
praisonai tui
Main TUI command group for interactive terminal interface.
launch
Launch the interactive TUI.
praisonai tui launch [OPTIONS]Options:
| Option | Short | Description |
|---|---|---|
--workspace | -w | Workspace directory |
--session | -s | Resume session ID |
--model | -m | Default model |
--debug | -d | Enable debug overlays |
--log-jsonl | Write events to JSONL file | |
--profile | Enable performance profiling |
Examples:
# Basic launch
praisonai tui launch
# Launch with specific model
praisonai tui launch --model gpt-4
# Resume a session
praisonai tui launch --session abc123
# Launch with debug logging
praisonai tui launch --debug --log-jsonl ./events.jsonlsimulate
Run a headless TUI simulation script for testing.
praisonai tui simulate SCRIPT [OPTIONS]Arguments:
| Argument | Description |
|---|---|
SCRIPT | Path to simulation script (YAML/JSON) |
Options:
| Option | Description |
|---|---|
--mock/--real-llm | Use mock provider (default) or real LLM |
--pretty/--jsonl | Output format |
--assert | Validate expected outcomes |
--timeout | Max execution time (default: 60s) |
Examples:
# Run simulation with mock provider
praisonai tui simulate test_script.yaml
# Run with real LLM (requires PRAISONAI_REAL_LLM=1)
PRAISONAI_REAL_LLM=1 praisonai tui simulate test_script.yaml --real-llm
# Run with assertions
praisonai tui simulate test_script.yaml --assertsnapshot
Print a TUI-like snapshot of current state.
praisonai tui snapshot [OPTIONS]Options:
| Option | Short | Description |
|---|---|---|
--session | -s | Filter by session ID |
--run | -r | Filter by run ID |
--json | -j | Output as JSON |
Examples:
# Get current snapshot
praisonai tui snapshot
# Get snapshot for specific session
praisonai tui snapshot --session abc123
# Get JSON output
praisonai tui snapshot --jsontrace
Replay events from persistence like a timeline.
praisonai tui trace ID [OPTIONS]Arguments:
| Argument | Description |
|---|---|
ID | Session or run ID to trace |
Options:
| Option | Short | Description |
|---|---|---|
--follow | -f | Follow new events |
--limit | -n | Max events to show (default: 50) |
Examples:
# Trace a session
praisonai tui trace abc123
# Follow events in real-time
praisonai tui trace abc123 --follow
# Limit to last 10 events
praisonai tui trace abc123 --limit 10In-session slash commands (checkpoint-aware)
Inside a running TUI session, /diff and /undo inspect and roll back workspace file changes.
| Command | Description |
|---|---|
/diff | Show file changes this session (--turn for the last turn, <file> for one file). Requires checkpoints.auto. |
/undo | Roll back the last turn’s file changes (and conversation history when a session store is wired). Requires checkpoints.auto. |
These commands are also available in the legacy praisonai code REPL and are backed by the same engine, so behaviour is identical.
praisonai queue
Queue management commands.
ls
List queued runs.
praisonai queue ls [OPTIONS]Options:
| Option | Short | Description |
|---|---|---|
--state | -s | Filter by state (queued, running, succeeded, failed, cancelled) |
--session | Filter by session ID | |
--limit | -n | Maximum results (default: 20) |
--json | -j | Output as JSON |
Examples:
# List all runs
praisonai queue ls
# List only running
praisonai queue ls --state running
# List with JSON output
praisonai queue ls --jsoncancel
Cancel a queued or running run.
praisonai queue cancel RUN_IDArguments:
| Argument | Description |
|---|---|
RUN_ID | Run ID to cancel (partial match supported) |
Examples:
# Cancel by full ID
praisonai queue cancel abc12345
# Cancel by partial ID
praisonai queue cancel abc1retry
Retry a failed run.
praisonai queue retry RUN_IDArguments:
| Argument | Description |
|---|---|
RUN_ID | Run ID to retry |
Examples:
praisonai queue retry abc12345clear
Clear all queued runs.
praisonai queue clear [OPTIONS]Options:
| Option | Short | Description |
|---|---|---|
--force | -f | Skip confirmation |
Examples:
# Clear with confirmation
praisonai queue clear
# Force clear
praisonai queue clear --forcestats
Show queue statistics.
praisonai queue stats [OPTIONS]Options:
| Option | Description |
|---|---|
--session | Filter by session ID |
Examples:
# Show all stats
praisonai queue stats
# Show stats for session
praisonai queue stats --session abc123Environment Variables
| Variable | Description |
|---|---|
PRAISONAI_REAL_LLM | Set to 1 to enable real LLM in simulations |
PRAISONAI_TUI_DEBUG | Set to 1 to enable debug mode |
PRAISONAI_TUI_JSONL | Path for JSONL event logging |
Best Practices
Use simulation flags in CI
Run praisonai simulate with mock providers to avoid live API spend in pipelines.
Enable JSONL logging for audits
Set PRAISONAI_TUI_JSONL when you need structured event replay after failures.
Keep debug mode off in production
PRAISONAI_TUI_DEBUG=1 is for local troubleshooting only — it adds verbose noise.
Document slash commands for your team
Share a cheatsheet of /context, queue, and simulate commands so operators behave consistently.