Skip to content

Commit 6ab24a5

Browse files
authored
docs: clarify TUI and CLI terminology in README (#51)
## Description This PR updates the README documentation to clarify the distinction between the TUI (Terminal User Interface) and CLI modes of the tool. The changes make it clearer that the tool serves two purposes: an interactive TUI mode for visual interaction and a traditional CLI mode for scripting and automation. ## Type of Change - [x] Documentation update ## Changes Made - Updated tagline to describe the tool as "TUI + CLI" instead of just "CLI" - Clarified that interactive mode is a "TUI" (Terminal User Interface) - Reorganized Usage section to clearly distinguish between TUI and CLI modes - Added explicit examples showing TUI mode vs CLI mode usage - Updated feature list to highlight both TUI and CLI capabilities - Improved clarity throughout by using precise terminology ## Testing - [x] Documentation changes reviewed for clarity and accuracy - [x] Build passes - [x] All 192 tests pass ## Checklist - [x] My code follows the code style of this project - [x] I have performed a self-review of my own code - [x] I have updated the documentation accordingly - [x] My changes generate no new warnings - [x] New and existing unit tests pass locally with my changes
1 parent 31ca3f0 commit 6ab24a5

1 file changed

Lines changed: 19 additions & 8 deletions

File tree

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![CI](https://github.com/runloopai/rl-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/runloopai/rl-cli/actions/workflows/ci.yml)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
66

7-
An interactive CLI for interacting with the [Runloop.ai](https://runloop.ai) platform. Use it as an **interactive command-line application** with rich UI components, or as a **traditional CLI** for scripting and automation.
7+
A **TUI + CLI** for the [Runloop.ai](https://runloop.ai) platform. Use it as an **interactive TUI** (Terminal User Interface) with rich UI components, or as a **traditional CLI** for scripting and automation.
88

99
📖 **[Full Documentation](https://docs.runloop.ai/docs/tools/cli)**
1010

@@ -15,10 +15,10 @@ An interactive CLI for interacting with the [Runloop.ai](https://runloop.ai) pla
1515
## Quick Example
1616

1717
```bash
18-
# Interactive mode - launches a beautiful UI menu
18+
# TUI mode - launches an interactive terminal UI
1919
rli
2020

21-
# Traditional CLI mode - perfect for scripts
21+
# CLI mode - perfect for scripts and automation
2222
rli devbox list # Outputs JSON/text
2323
rli devbox create --name my-devbox
2424
rli devbox exec <devbox-id> echo "Hello World"
@@ -27,10 +27,11 @@ rli devbox delete <devbox-id>
2727

2828
## Features
2929

30+
- 🖥️ **TUI mode** — Interactive terminal UI with menus, tables, and real-time updates
31+
- 🎯 **CLI mode** — Traditional commands with text, JSON, and YAML output for scripting
3032
- ⚡ Fast and responsive with pagination
3133
- 📦 Manage devboxes, snapshots, and blueprints
32-
- 🚀 Execute commands, ssh, view logs in devboxes
33-
- 🎯 Traditional CLI with text, json, and yaml output modes.
34+
- 🚀 Execute commands, SSH, view logs in devboxes
3435
- 🤖 **Model Context Protocol (MCP) server for AI integration**
3536

3637
## Installation
@@ -53,13 +54,23 @@ Get your API key from [https://runloop.ai/settings](https://runloop.ai/settings)
5354

5455
## Usage
5556

56-
### Interactive CLI
57+
### TUI (Interactive Mode)
5758

5859
```bash
59-
rli # Run the interactive console
60+
rli # Launch the interactive TUI
6061
rli --help # See help information
6162
```
6263

64+
### CLI (Scripting Mode)
65+
66+
All commands support `--output` (`-o`) for format control:
67+
68+
```bash
69+
rli devbox list # Default text output
70+
rli devbox list -o json # JSON output
71+
rli devbox list -o yaml # YAML output
72+
```
73+
6374
## Command Structure
6475

6576
The CLI is organized into command buckets:
@@ -160,7 +171,7 @@ rli mcp start --http --port 8080
160171

161172
## Theme Configuration
162173

163-
The CLI supports both light and dark terminal themes and will automatically select the appropriate theme.
174+
The TUI supports both light and dark terminal themes and will automatically select the appropriate theme.
164175

165176
## Development
166177

0 commit comments

Comments
 (0)