Examples

Point the terminal client at another API host

Connect the redgold terminal client to a self-hosted instance with --api or REDGOLD_API.

Goal

Point the terminal client at an API host other than the managed default — for example a self-hosted instance.

Prerequisites

Steps

The installer points the client at the managed API host, so in the common case you only supply a key. To reach a different host, pass --api <url> or set REDGOLD_API. The key can come from --key / REDGOLD_KEY.

Run with no mode flag first to confirm the wiring on the status screen:

REDGOLD_API=https://api.example.internal REDGOLD_KEY=sk-rg-... redgold

Once the status screen shows the right host and key set, open a live view. --env <repo> opens the environment view for a repository, where you can spawn (s) and stop (x) sessions:

redgold --env redgold --api https://api.example.internal --key sk-rg-...

Expected output

The status screen shows the API host you passed and the WebSocket URL derived from it. In --env, the environment and its live sessions list as the server reports them; no environments yet — attaching means the environment is still coming up — wait for it to reach RUNNING.

When it breaks

  • Status screen shows the wrong host — the flag or env var did not reach the client. --api overrides REDGOLD_API; confirm which one you set.
  • Status screen shows key: none — the host-specific key was not picked up. Set --key / REDGOLD_KEY.
  • no environments yet — attaching stays on screen — the environment has not reached RUNNING yet. Wait, or check the host.

Source

Terminal client reference (authentication and connection settings).

Copyright © 2026