@runloop/rl-cli

Runloop CLI

A beautiful CLI for managing Runloop built with Ink and TypeScript. Use it as an interactive command-line application with rich UI components, or as a traditional CLI for scripting and automation.

Quick Example

# Interactive mode - launches a beautiful UI menu
rli

# Traditional CLI mode - perfect for scripts
rli devbox list                    # Outputs JSON/text
rli devbox create --name my-devbox
rli devbox exec <devbox-id> echo "Hello World"
rli devbox delete <devbox-id>

Features

• ⚡ Fast and responsive with pagination
• 📦 Manage devboxes, snapshots, and blueprints
• 🚀 Execute commands in devboxes
• 🎯 Organized command structure with aliases
• 🤖 Model Context Protocol (MCP) server for AI integration

Installation

Install globally via npm:

npm install -g @runloop/rl-cli

Setup

Configure your API key:

export RUNLOOP_API_KEY=your_api_key_here

Get your API key from https://runloop.ai/settings

Usage

Interactive CLI

rli                    # Run the interactive console
rli --help             # See help information

Command Structure

The CLI is organized into command buckets:

Devbox Commands (alias: d)

rli devbox create                        # Create a new devbox
rli devbox list                          # List all devboxes
rli devbox delete <id>                   # Shutdown a devbox
rli devbox exec <id> <command...>        # Execute a command in a devbox
rli devbox exec-async <id> <command...>  # Execute a command asynchronously on a...
rli devbox upload <id> <file>            # Upload a file to a devbox
rli devbox get <id>                      # Get devbox details
rli devbox get-async <id> <execution-id> # Get status of an async execution
rli devbox suspend <id>                  # Suspend a devbox
rli devbox resume <id>                   # Resume a suspended devbox
rli devbox shutdown <id>                 # Shutdown a devbox
rli devbox ssh <id>                      # SSH into a devbox
rli devbox scp <id> <src> <dst>          # Copy files to/from a devbox using scp
rli devbox rsync <id> <src> <dst>        # Sync files to/from a devbox using rsync
rli devbox tunnel <id> <ports>           # Create a port-forwarding tunnel to a ...
rli devbox read <id>                     # Read a file from a devbox using the API
rli devbox write <id>                    # Write a file to a devbox using the API
rli devbox download <id>                 # Download a file from a devbox
rli devbox send-stdin <id> <execution-id> # Send stdin to a running async execution
rli devbox logs <id>                     # View devbox logs

Snapshot Commands (alias: snap)

rli snapshot list                        # List all snapshots
rli snapshot create <devbox-id>          # Create a snapshot of a devbox
rli snapshot delete <id>                 # Delete a snapshot
rli snapshot get <id>                    # Get snapshot details
rli snapshot status <snapshot-id>        # Get snapshot operation status

Blueprint Commands (alias: bp)

rli blueprint list                       # List all blueprints
rli blueprint create                     # Create a new blueprint
rli blueprint get <name-or-id>           # Get blueprint details by name or ID (...
rli blueprint logs <name-or-id>          # Get blueprint build logs by name or I...

Object Commands (alias: obj)

rli object list                          # List objects
rli object get <id>                      # Get object details
rli object download <id> <path>          # Download object to local file
rli object upload <path>                 # Upload a file as an object
rli object delete <id>                   # Delete an object (irreversible)

Mcp Commands

rli mcp start                            # Start the MCP server
rli mcp install                          # Install Runloop MCP server configurat...

MCP Server (AI Integration)

Runloop includes a Model Context Protocol (MCP) server that allows AI assistants like Claude to interact with your devboxes.

Quick Setup for Claude Desktop

# Install MCP configuration
rli mcp install

# Restart Claude Desktop, then ask Claude:
# "List my devboxes" or "Create a new devbox"

Starting the Server

# Stdio mode (for Claude Desktop)
rli mcp start

# HTTP mode (for web/remote access)
rli mcp start --http
rli mcp start --http --port 8080

Documentation:

• CLAUDE_SETUP.md - Complete setup guide for Claude Desktop
• MCP_README.md - Full MCP documentation
• MCP_COMMANDS.md - Quick command reference

Theme Configuration

The CLI supports both light and dark terminal themes and will automatically select the appropriate theme.

Development

# Install dependencies
npm install

# Build
npm run build

# Watch mode
npm run dev

## Contributing

We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to contribute to this project.

## License

MIT