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.
The streampixel command takes an Unreal Engine project from your computer to a live stream. It checks the project, packages it with Unreal’s own tools, uploads the build, makes it live and starts a test session to confirm a picture arrives. It is made for people, for CI jobs and for AI coding agents alike.
You do not need the command line to use Streampixel. It is one way to put a build live: you can also upload it in the dashboard, let cloud builds package it from your repository, or give the REST API’s Upload File endpoint a download link to a zip you host.

Install

You need Node.js 20 or later.
Or run any command without installing:

Sign in

Your browser opens the Streampixel dashboard. Sign in as usual and press Allow. The command line is then signed in as you and can do what you can do in the dashboard. There is no API key to copy.
  • The sign-in is kept in your system’s credential store: Windows Credential Manager, macOS Keychain or the Linux Secret Service. Where none is available, it is kept in a file only your user can read.
  • It is refreshed by itself. Tokens are never printed.
  • streampixel login --no-browser prints the link to open yourself, for example on a remote machine.
  • streampixel logout removes the sign-in from this computer.
Sign in to the dashboard at least once before, so your account exists.
For a CI job, where nobody can open a browser, use an API key instead. See Scripts and CI.

Put a project live

Run these from your Unreal project folder (the one with the .uproject):
1

Find your project id

Lists your projects and their ids. --project takes the id.
2

Check the project

Says whether the project is ready to stream, and what to do about each problem.
3

Package it (Windows)

Packages a Windows build with Unreal’s own tools.
4

Upload it

Zips and uploads the build, then waits until Streampixel has processed it.
5

Make it live

If your project releases processed builds automatically, upload already waited until the build was live and you can skip this step.
6

Test it

Starts one short session and reports whether a picture arrived.
Commands describes each command and its options.