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.
streampixel <command> --help lists each command’s options. Every command also takes --json (see Scripts and CI). Where a command takes --project, you can set STREAMPIXEL_PROJECT instead. Where it takes --project-path, the default is the current folder; you can pass the .uproject file or its folder.
package needs Windows with Unreal Engine installed. On macOS or Linux you can still run doctor, upload a build packaged on Windows, deploy and test.

login

Opens the Streampixel sign-in page in your browser. Sign in and press Allow. See Install and sign in.

whoami

Shows the signed-in account and its projects with their ids.

init

Sets up the Unreal project for AI coding agents. It adds a Streampixel section to the project’s AGENTS.md and a Claude Code skill in .claude/skills/streampixel/. See With an AI coding agent.

doctor

Checks the Unreal project:
  • exactly one Pixel Streaming plugin is enabled (Pixel Streaming, or Pixel Streaming 2 on Unreal Engine 5.5 and later);
  • the engine is installed, and its version;
  • Windows is a target platform;
  • a default map is set;
  • C++ toolchain needs;
  • path length.
Each problem comes with what to do. The engine is found from the .uproject’s engine version: the Windows registry, then the Epic Games Launcher’s list of installed engines, then C:\Program Files\Epic Games\UE_x.y. Source-built engines are found by their registered id. --engine overrides all of it.

package

Packages the project for Windows with Unreal’s own RunUAT BuildCookRun, using your project’s packaging settings. A failure is reported with the file and line, or the asset, and what to do, and names the full log file.
Close the Unreal Editor before packaging if Live Coding is active or a file is locked.

upload

Checks the packaged folder the way Streampixel will, zips it, uploads it and waits until Streampixel has processed it. If your project releases processed builds automatically, it waits until the build is live. An interrupted upload resumes when you run the same command again.
path is a packaged Windows folder or a .zip. By default it is the last streampixel package output in this folder.

deploy

Makes a build the live one and waits until it is on the streaming servers.

test

Starts one short session of the project in a headless Chrome or Edge. It reports whether a picture arrived, the codec and the time to the first frame, or why the session ended. It also prints the session id.
test is experimental. Each run uses a streaming server and one of the project’s concurrent-user slots while it runs, so run it once per deploy, not in a loop.