Mohamed BoudraandGitHub
d2de309fc3
* feat: make relay opt-in for device pairing * fix(relay): keep pairing state authoritative * fix(relay): refresh pairing state across transports * fix(onboard): honor explicit relay opt-out * fix(relay): surface transport startup failures * fix(pairing): gate offers for older daemons * test(cli): rely on real pairing transport coverage * fix(cli): report live relay without a pid file * fix(relay): synchronize config during daemon startup * fix(relay): preserve mutability for ignored overrides * fix(cli): use reachable daemon for pairing * fix(app): redirect invalid pair device routes * fix(pairing): support remote host device pairing Keep Pair Device host-relative through the existing settings and daemon RPC flow. Route CLI output through an injected adapter so workflow tests do not mutate process globals. * fix(pairing): validate pairing destinations Expose the host-relative Pair Device flow on every supported app platform. Reject a reachable daemon whose identity does not match the requested Paseo home before reading or mutating its pairing state. * fix(pairing): render QR codes across platforms Generate SVG text without DOM or canvas and render it through the existing cross-platform SVG stack. * fix(cli): pair from persisted relay state Allow explicit relay pairing while the daemon is stopped when relay is already enabled in persisted configuration.
67 lines
2.9 KiB
Markdown
67 lines
2.9 KiB
Markdown
---
|
|
title: Getting started
|
|
description: Install Paseo and start running coding agents from anywhere.
|
|
nav: Getting started
|
|
order: 1
|
|
category: Getting started
|
|
---
|
|
|
|
# Getting started
|
|
|
|
Paseo runs your coding agents on your machine and gives you a mobile, desktop, web, and CLI client to drive them from anywhere. Three common ways to install.
|
|
|
|
## Desktop app (recommended)
|
|
|
|
Download from [paseo.sh/download](https://paseo.sh/download) or the [GitHub releases page](https://github.com/getpaseo/paseo/releases). Open it and you're done.
|
|
|
|
The desktop app bundles its own daemon and starts it automatically, no separate install required. On first launch you'll see a brief startup screen, then connect from your phone using **Settings → your host → Pair Device**.
|
|
|
|
## Server / CLI
|
|
|
|
For headless machines, dev boxes, or any setup where you want the daemon running without the desktop UI:
|
|
|
|
```bash
|
|
npm install -g @getpaseo/cli
|
|
paseo
|
|
```
|
|
|
|
Paseo starts the daemon locally, then asks whether to enable the end-to-end encrypted relay and print a pairing QR code. If you decline, enter the daemon address manually over TCP, Tailscale, or another VPN.
|
|
|
|
The daemon can also serve the browser web app itself, so you can use the full UI without the hosted app. See [Self-hosting the web UI](/docs/web-ui).
|
|
|
|
Configuration and local state live under `PASEO_HOME` (defaults to `~/.paseo`).
|
|
|
|
## Docker
|
|
|
|
For servers, dev boxes, NAS devices, or homelab hosts, run the official image:
|
|
|
|
```bash
|
|
docker run -d --name paseo \
|
|
-p 6767:6767 \
|
|
-e PASEO_PASSWORD=change-me \
|
|
-v "$PWD/paseo-home:/home/paseo" \
|
|
-v "$PWD:/workspace" \
|
|
ghcr.io/getpaseo/paseo:latest
|
|
```
|
|
|
|
Then open `http://localhost:6767`.
|
|
|
|
The image runs the daemon and serves the bundled web UI. It does not bundle agent CLIs, so extend it with the agents you use. See [Docker](/docs/docker) for Compose, reverse proxy, agent install, and security examples.
|
|
|
|
## Where next
|
|
|
|
- [Docker](/docs/docker), run the daemon and bundled web UI in a container.
|
|
- [Workspaces](/docs/workspaces), the project, workspace, and session model Paseo is built around.
|
|
- [Providers](/docs/providers), what a provider is and how Paseo wraps existing CLIs.
|
|
- [Orchestration](/docs/orchestration), let one agent delegate work to other providers and models.
|
|
- [CLI reference](/docs/cli), every command.
|
|
- [Self-hosting the web UI](/docs/web-ui), serve the browser app from your own daemon.
|
|
- [GitHub repo](https://github.com/getpaseo/paseo)
|
|
- [Report an issue](https://github.com/getpaseo/paseo/issues)
|
|
|
|
## Prerequisites
|
|
|
|
Paseo manages other agents, it doesn't ship one. Before it's useful, install at least one provider CLI yourself and make sure it works with your credentials. See [Supported providers](/docs/supported-providers) for the full list.
|
|
|
|
You'll also want the [GitHub CLI](https://cli.github.com/) (`gh`) installed and authenticated, Paseo uses it for PR-aware worktrees and a few orchestration features.
|