Skip to main content

Use the TUI

The OpenRAG Terminal User Interface (TUI) provides a simplified and guided experience for configuring, managing, and monitoring your OpenRAG deployment directly from the terminal.

OpenRAG TUI Interface

If you install OpenRAG with the automatic installer script, uv, or uvx, you use the TUI to manage your OpenRAG deployment. The TUI guides you through the initial setup, automatically manages your OpenRAG .env and docker-compose files, and provides convenient access to service management controls.

In contrast, when you deploy OpenRAG with self-managed services, you must manually configure OpenRAG by preparing a .env file and using Docker or Podman commands to deploy and manage your OpenRAG services.

Access the TUI​

If you installed OpenRAG with uv, access the TUI with uv run openrag.

If you installed OpenRAG with the automatic installer script or uvx, access the TUI with uvx openrag.

Manage services with the TUI​

Use the TUI's Status menu (3) and Diagnostics menu (4) to access controls and information for your OpenRAG services. For more information, see Manage OpenRAG services.

Exit the OpenRAG TUI​

To exit the OpenRAG TUI, go to the TUI main menu, and then press q.

Your OpenRAG containers continue to run until they are stopped.

To restart the TUI, see Access the TUI.