Getting Started with the RosettaHub CLI¶

Beginner 10 minutes

Overview¶

The rh command-line interface lets you manage every aspect of the RosettaHub from your terminal. In this tutorial you will connect to RosettaHub, configure your defaults, and run your first commands.

Prerequisites¶

[ ] RosettaHub account with active subscription
[ ] The rh CLI installed and the RosettaHub daemon running
[ ] At least one cloud account connected to your organization

Steps¶

Step 1: Check the Daemon Is Running¶

Before doing anything, verify the RosettaHub daemon is ready:

rh status

If the daemon is not running, start it before continuing.

Step 2: Log In¶

Create a connection to RosettaHub. You can authenticate with username/password or an API key:

# With username (you will be prompted for your password)
rh login -u myuser

# With username and password
rh login -u myuser -p mypassword

# With an API key
rh login -k my-api-key

On success the connection is created and displayed in a table. You can create multiple connections (one per user).

Step 3: List Connections¶

View all connections you have established:

rh ls

Step 4: Set the Default Connection¶

Set which connection to use by default:

rh set-default myuser

Verify which connection is active:

rh get-default

Step 5: Check Your Identity¶

Confirm who you are logged in as:

rh whoami

This shows your username, organization, and role flags.

Step 6: Configure Cloud and Region¶

Set the default cloud provider and region for new resources:

rh set-cloud aws
rh set-region us-east-1

Or set both at once:

rh set-cloud-region aws us-east-1

Verify your settings:

rh get-cloud
rh get-region

Tip

Run rh settings to see all current defaults in one view.

Step 7: Set the Output Format¶

Choose how command output is displayed:

rh set-output table    # default, human-readable
rh set-output json     # machine-readable JSON
rh set-output yaml     # YAML format
rh set-output csv      # spreadsheet-friendly

Check the current format:

rh get-output

You can also override the format per command using the -O flag:

rh formation ls -O json

Step 8: Explore Commands¶

All commands support these global flags:

Flag	Description
`-q`, `--quiet`	Suppress non-essential output
`-y`, `--yes`	Skip confirmation prompts
`-dr`, `--dry-run`	Preview without executing
`-O`, `--output`	Override output format per command

Use --help on any command to see available options:

rh formation --help
rh formation launch --help

Step 9: Use the Config Shortcut¶

The rh config command groups all configuration commands in one place:

rh config set-cloud aws
rh config set-region eu-west-1
rh config set-output json
rh config settings

Next Steps¶

Managing Projects and Organizations — organize your work
Creating and Launching Formations — launch your first machine

Troubleshooting¶

'rh status' says daemon is not ready

Start the RosettaHub daemon before running any CLI commands.

Login fails

Double-check your username and password. If using an API key, ensure it has not expired.

How do I switch between users?

Create a new connection with rh login -u otheruser, then switch with rh set-default otheruser.