Stably CLI

A command-line interface tool for interacting with Stably services.

Installation

# Install globally
npm install -g stably

# Or use npx
npx stably

Authentication

Before using the CLI, you need to authenticate with your Stably API key.

Getting Your API Key

1. Visit the Stably API Keys page: https://auth.stably.ai/api_keys/personal
2. Create a new Personal API Key
3. Copy the generated API Key

Authentication Methods

Using the auth command

# Authenticate with API key
stably auth --api-key YOUR_API_KEY

# Or let the CLI prompt you for the API key
stably auth

The CLI will store your API key securely for future use.

Development Server

Start a development server with a secure tunnel to expose your local environment.

# Start development server on default port (3000)
stably dev

# Specify a custom port
stably dev --port 8080

The CLI will:

1. Start a development server on the specified port
2. Create a secure tunnel to expose your local environment
3. Provide you with a public URL where your local environment is accessible

Troubleshooting

Authentication Issues

• If you receive an "Invalid Personal API Key" error, verify that:
  1. The API key is correct and hasn't been revoked
  2. You're using a Personal API Key, not an Organization API Key
  3. The API key has the necessary permissions

Development Server Issues

• If the development server fails to start:
  1. Ensure the specified port is available
  2. Check if you're authenticated (run stably auth if needed)
  3. Verify your API key has the necessary permissions

Contributing

For information on how to contribute to this project, including development setup and available scripts, please see CONTRIBUTING.md.

Support

For additional help or to report issues, please contact the Stably support team.