Loading docs
Skip to main content

Rumpty CLI

Manage workspaces, VMs, and resources on the RumptyCloud platform from your terminal.

RumptyCloud

Sanmọ̀Labs™ - Surpass your limits!

rumpty 0.0.3

Install

Download the CLI → (tar.gz)

Extract and move to a directory of your choice:

tar -xzf rumpty-*.tar.gz -C /usr/local/bin/rumpty-cli

Configure environment variables

The CLI requires two environment variables to connect to the platform:

export RUMPTY_API_KEY="your-api-key"
export RUMPTY_API_URL="https://api.rumptycloud.com"

Get your API key from Settings → API Keys.

Add these to your shell profile (~/.bashrc, ~/.zshrc, etc.) to persist across sessions.

Add to PATH

Add the CLI directory to your PATH:

export PATH="$PATH:/usr/local/bin/rumpty-cli"

Reload your shell or run source ~/.bashrc (or ~/.zshrc) for the change to take effect.

Verify the install:

rumpty --version

Global flags

These flags work with any command:

FlagEnv variableDescription
--tokenRUMPTY_API_KEYYour Rumpty API key
--api-urlRUMPTY_API_URLRumpty API base URL
--ws / --workspaceRUMPTY_WORKSPACEWorkspace slug
--log-levelRUMPTY_LOG_LEVELLog level: error, warn, info, debug
-v, --verboseEnable debug logging (same as --log-level=debug)

Available commands

CommandDescription
loginAuthenticate with Rumpty
logoutRemove the local Rumpty session
sshOpen an SSH session to a workspace VM
copyCopy files between your machine and a VM
execRun a non-interactive command on a VM
exposeExpose a VM service with a public URL
unexposeRemove a VM service public URL
vmManage workspace VMs
workspacesList workspaces you can access
completionGenerate shell autocompletion script

Use rumpty [command] --help for details on any command.