Skip to main content
Beta. The Streampixel command line (version 0.1.0-beta.1) and the Streampixel MCP server are in beta. Commands, tools and their output can still change before the stable release.

JSON output

Add --json to any command. It then prints exactly one JSON document on standard output, and the exit code says how it went. Progress goes to standard error.
  • error.hint says what to do.
  • data.next names the next command.
  • On a failure, data holds what was done before it failed, for example the buildId of a build that was uploaded and then rejected.
  • Branch on error.code, never on the wording of message.

Exit codes

Common error codes

Sign in without a browser

Where nobody can open a browser, set STREAMPIXEL_API_KEY to a key from API keys.
  • A key with the read scope can run whoami and follow builds.
  • deploy needs the control scope.
  • Uploading a build file needs streampixel login.
Never print, log or commit an API key. Keep it in your CI system’s secrets.

Environment variables