> ## Documentation Index
> Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Commands

> Every streampixel command and its options: login, whoami, init, doctor, package, upload, deploy and test.

> [!NOTE]
>
> **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.

| Command | What it does |
| - | - |
| `login` | Signs in through the dashboard in your browser. |
| `logout` | Removes the saved sign-in from this computer. |
| `whoami` | Shows your account and its projects with their ids (what `--project` takes). |
| `init` | Sets up the Unreal project for AI coding agents. |
| `doctor` | Checks the project is ready to stream. |
| `package` | Packages the project for Windows with Unreal's own tools. |
| `upload` | Zips and uploads a packaged build, then waits until Streampixel has processed it. |
| `deploy` | Makes a build the live one and waits until it is on the streaming servers. |
| `test` | Starts one short session and reports whether a picture arrived. |

`streampixel <command> --help` lists each command's options. Every command also takes `--json` (see [Scripts and CI](https://docs.streampixel.io/resources/ai-and-cli/command-line/scripts-and-ci.md)).

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.

> [!WARNING]
>
> `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](https://docs.streampixel.io/resources/ai-and-cli/command-line/install-and-sign-in.md#sign-in).

| Option | Meaning |
| - | - |
| `--no-browser` | Do not open a browser; print the link to open yourself. |
| `--timeout <seconds>` | How long to wait for the browser. Default 300. |

## 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](https://docs.streampixel.io/resources/ai-and-cli/command-line/ai-coding-agents.md).

| Option | Meaning |
| - | - |
| `--project <id>` | The Streampixel project this Unreal project deploys to. Recorded for agents. |
| `--project-path <path>` | The `.uproject` file or its folder. |
| `--dry-run` | Say what would be written; write nothing. |
| `--force` | Replace a `.claude/skills/streampixel/SKILL.md` that `streampixel` did not write. |

## 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.

| Option | Meaning |
| - | - |
| `--project-path <path>` | The `.uproject` file or its folder. |
| `--engine <dir>` | The Unreal Engine folder (the one that contains `Engine\`). Found automatically by default. |

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.

| Option | Meaning |
| - | - |
| `--config <name>` | `Shipping` (default) or `Development`. |
| `--output <dir>` | Where to put the packaged build. Default `<project>/Saved/Streampixel/Package`. |
| `--clean` | Rebuild everything. |
| `--dry-run` | Print the command without running it. Works on any system. |
| `--skip-checks` | Package even if the Pixel Streaming plugin check fails. |
| `--project-path <path>` | The `.uproject` file or its folder. |
| `--engine <dir>` | The Unreal Engine folder. Found automatically by default. |

> [!TIP]
>
> 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.

```bash theme={"dark"}
streampixel upload [path] --project <project id>
```

`path` is a packaged Windows folder or a `.zip`. By default it is the last `streampixel package` output in this folder.

| Option | Meaning |
| - | - |
| `--project <id>` | The Streampixel project id. |
| `--no-wait` | Return once the build is uploaded and registered; do not wait for processing. |
| `--timeout <minutes>` | How long to wait for processing. Default 60. |
| `--zip-dir <dir>` | Where to write the zip. Default: next to the build folder. |

## deploy

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

| Option | Meaning |
| - | - |
| `--project <id>` | The Streampixel project id. |
| `--build <id>` | The build. Default: the last build uploaded from this computer, else the newest ready build. |
| `--no-wait` | Return once the build is set as active; do not wait until it is live. |
| `--timeout <minutes>` | How long to wait until it is live. Default 60. |

## 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.

| Option | Meaning |
| - | - |
| `--project <id>` | The Streampixel project id. |
| `--password-env <VAR>` | For a password-protected project: the **name** of the environment variable that holds the viewer password. |
| `--timeout <seconds>` | How long to wait for the first frame. Default 120. A cold start can take a minute. |
| `--browser <path>` | The Chrome or Edge to use. Found automatically by default. |

> [!WARNING]
>
> `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.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.