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

# Quickstart

> Go from a clean clone to a local sample image without a provider key.

# Quickstart

## What this lets you do

Run a complete local DreamLayer sample without a provider key or a paid service.

## What you need

* Git
* Python 3.11 or later
* `uv`
* Node.js 22.12 or later
* `pnpm` 10
* A current browser

## Steps

### 1. Clone and start

```bash theme={null}
git clone https://github.com/TheDesignFounder/dreamlayer-runtime
cd dreamlayer-runtime
./dreamlayer
```

The launcher prints the loopback URL for DreamLayer WebUI. Sample mode calls no provider and spends nothing.

### 2. Generate the sample

Open DreamLayer WebUI, enter a prompt, keep the sample connector selected, and create the image. The job should move through `queued`, `running`, and `completed`.

### 3. Check the installation

```bash theme={null}
./dreamlayer doctor --json
```

Keep the JSON output when requesting support. It reports versions and sanitized readiness, not prompts, local paths, images, or keys.

## Confirm it worked

The sample job reaches `completed`, one image appears in DreamLayer WebUI, and `./dreamlayer doctor --json` reports the local services as ready.

## Common errors

| Error                         | What to do                                                            |
| ----------------------------- | --------------------------------------------------------------------- |
| `uv` or `pnpm` is unavailable | Install the missing prerequisite, then run `./dreamlayer` again.      |
| The loopback port is busy     | Open the exact URL printed by the launcher or free the reported port. |
| A job does not complete       | Read its canonical job state before submitting another turn.          |

## Troubleshooting

Run `./dreamlayer doctor --json` again and keep the sanitized output. See [Troubleshooting](/troubleshooting) for setup and recovery checks.

## Next steps

* [Connect local ComfyUI](/local-comfyui)
* [Install a Python or TypeScript SDK](/sdks/python)
* [Use the MCP server](/mcp)
* [Try DreamLayer Agent API with a test key](/agent-api)
