Skip to Content

🛠️ SkyCaster Rendering Client – Usage Guide

The SkyCaster Rendering Client renders and streams weather map configurations from your terminal using the skycaster command.

⚙️ Usage

skycaster --configs=<name:secs,...> --apiKey=<key> [options]
skycaster --config=<name> --apiKey=<key> [options]

Required (one of)

  • --configs — Comma-separated list of config:duration pairs e.g. --configs=NYC-weather:30,RTS-flyover:60
  • --config — Single config name (use with --duration)
  • --apiKey — Your SkyCaster API key

Optional

  • --duration — Duration in seconds for single --config mode (default: 30)
  • --fps — Frames per second (default: 30)
  • --res — Resolution WxH (default: 1920x1080)
  • --bitrate — Video bitrate in kbps (default: 8000)
  • --transition — Transition duration in seconds between configs (default: 5)
  • --output — Output file path (default: output-<config>.mp4)
  • --local — Load config from a local .json file instead of the API
  • --no-gpu — Use CPU (SwiftShader) renderer instead of GPU

🧠 Examples

Render two configs back-to-back (30 s + 60 s):

skycaster --configs=NYC-weather:30,RTS-flyover:60 --apiKey=abc123

Single config at higher frame rate:

skycaster --config=NYC-weather --apiKey=abc123 --duration=45 --fps=60

Custom resolution and output path:

skycaster --configs=A:20,B:20,C:20 --apiKey=abc123 --res=1920x1080 --output=out.mp4

Use a local JSON config file:

skycaster --config=my-config --apiKey=abc123 --local

🧩 Notes

  • The --config value must match a configuration name created in your SkyCaster Dashboard, unless --local is used.
  • When --local is enabled, the client reads <configName>.json from the current directory.
  • --apiKey is required in all modes, including --local.
  • FFmpeg is bundled — no separate installation required.

🆘 Troubleshooting

  • Ensure your API key is valid and active.
  • Use --no-gpu if you encounter rendering issues on headless or virtual machines.

📞 Need Help?

Last updated on
🔐 Authentication