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

# Install and sign in

> Install the Streampixel command line, sign in through the dashboard and put an Unreal Engine project live from a terminal.

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

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.

> [!NOTE]
>
> 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](https://docs.streampixel.io/resources/dashboard/builds.md), let [cloud builds](https://docs.streampixel.io/resources/cloud-builds/overview.md) package it from your repository, or give the REST API's [Upload File](https://docs.streampixel.io/resources/api-reference/upload-file-api.md) endpoint a download link to a zip you host.

## Install

You need [Node.js](https://nodejs.org) 20 or later.

```bash theme={"dark"}
npm install -g @streampixel/cli@beta
```

Or run any command without installing:

```bash theme={"dark"}
npx @streampixel/cli@beta <command>
```

## Sign in

```bash theme={"dark"}
streampixel login
```

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.

> [!NOTE]
>
> Sign in to the [dashboard](https://dashboard.streampixel.io) 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](https://docs.streampixel.io/resources/ai-and-cli/command-line/scripts-and-ci.md#sign-in-without-a-browser).

## Put a project live

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

**1. Find your project id**

```bash theme={"dark"}
streampixel whoami
```

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

**2. Check the project**

```bash theme={"dark"}
streampixel doctor
```

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

**3. Package it (Windows)**

```bash theme={"dark"}
streampixel package
```

Packages a Windows build with Unreal's own tools.

**4. Upload it**

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

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

**5. Make it live**

```bash theme={"dark"}
streampixel deploy --project <project id>
```

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

**6. Test it**

```bash theme={"dark"}
streampixel test --project <project id>
```

Starts one short session and reports whether a picture arrived.

[Commands](https://docs.streampixel.io/resources/ai-and-cli/command-line/commands.md) describes each command and its options.


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