Authentication

Manage your Runtime authentication and credentials. Authenticate with the Runtime API.

runtm login

Options

Option	Short	Description
`--token TOKEN`	`-t`	API token (will prompt if not provided)
`--device`		Use browser-based device flow (hosted only)
`--no-verify`		Skip API validation (for self-hosted/offline)
`--force`	`-f`	Replace existing token without prompting

Examples

runtm login
# Follow the prompts to enter your API key

runtm login --token runtm_abc123xyz

runtm login --token my-token --no-verify

runtm login --force

Getting an API Key

Go to app.runtm.com
Sign in or create an account
Navigate to API Keys
Create a new API key
Copy and paste into runtm login

API keys are shown only once. Save them securely.

logout

Remove saved API credentials.

runtm logout

Options

Option	Short	Description
`--force`	`-f`	Skip confirmation prompt

Examples

# With confirmation
runtm logout

# Skip confirmation
runtm logout --force

If you’re using RUNTM_API_KEY environment variable, you’ll need to unset it manually:

unset RUNTM_API_KEY

doctor

Check CLI setup and diagnose issues.

runtm doctor

Output

The doctor command shows:

CLI version
API URL (default or custom)
Auth storage (keychain, file, or env)
Auth status (authenticated user email)
Credentials (file permissions if using file storage)
Connectivity (API reachability and latency)

Example Output

runtm v0.2.6

  API URL:      https://app.runtm.com/api
  Auth storage: keychain (runtm-api-key)
  Auth status:  ✓ Authenticated as [email protected]
  Connectivity: ✓ API reachable (42ms)

  Ready to deploy! Run: runtm init backend-service

Troubleshooting with Doctor

Auth status shows '✗ Not authenticated'

Run runtm login to authenticate with your API key.

Auth status shows '✗ Token invalid or expired'

Your token may have been revoked. Create a new one at app.runtm.com.

Connectivity shows '✗ Could not connect to API'

Check your internet connection. If self-hosting, verify the API URL:

runtm config set api_url=https://your-api.example.com

Credentials shows permission warning

Fix file permissions:

chmod 600 ~/.runtm/credentials

version

Show CLI version.

runtm version

Output:

runtm v0.2.6

Token Storage

The CLI stores tokens securely based on your platform:

macOS

Uses the system Keychain. You can view stored credentials in Keychain Access.app under “runtm-api-key”.

Linux

Stores in ~/.runtm/credentials with restricted permissions (mode 600). Only your user can read the file.

Environment Variable

You can set RUNTM_API_KEY to avoid storing credentials:

export RUNTM_API_KEY=runtm_abc123xyz

This takes precedence over stored credentials.

Self-Hosted Authentication

When using a self-hosted Runtime instance:

# Configure API URL
runtm config set api_url=https://runtm.internal.example.com/api

# Login with --no-verify if the API doesn't have /v1/me endpoint yet
runtm login --no-verify

See Self-Hosting for complete setup instructions.

Open Source

Guides

Features

OSS Templates

CLI Reference

Self-Hosting

OSS API

Deployments

Logs

Domains

User

Authentication

Authentication

Options

Examples

Getting an API Key

logout

Options

Examples

doctor

Output

Example Output

Troubleshooting with Doctor

version

Token Storage

macOS

Linux

Environment Variable

Self-Hosted Authentication

​Authentication

​login

​Options

​Examples

​Getting an API Key

​logout

​Options

​Examples

​doctor

​Output

​Example Output

​Troubleshooting with Doctor

​version

​Token Storage

​macOS

​Linux

​Environment Variable

​Self-Hosted Authentication

Authentication

login

Options

Examples

Getting an API Key

logout

Options

Examples

doctor

Output

Example Output

Troubleshooting with Doctor

version

Token Storage

macOS

Linux

Environment Variable

Self-Hosted Authentication