Mohamed BoudraandGitHub
16120ebff1
* feat(plugins): expose Paseo API to local plugins Plugin surfaces borrow the selected host connection while subprocess handlers receive an exclusively owned IPC session, so plugins can use normal workspace and agent operations without inventing another transport. * feat(plugins): reload global enablement safely Treat the global plugin switch as a live daemon setting and teach plugin automation to inspect it before acting. Enabling remains permission-gated because plugin backend code can access the daemon machine and client contributions execute inside the app. * feat(plugins): expose plugin logs Capture plugin stdout and stderr separately from IPC so authors can debug initialization, RPC, cleanup, and crash behavior from the app or CLI. Keep a bounded tail across lifecycle recovery while preserving structured output in the daemon log. * fix(build): order plugin dependency builds * test(plugins): align startup and CLI expectations
69 lines
3.1 KiB
Markdown
69 lines
3.1 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
|
|
|
|
- [Connectivity](/docs/connectivity), connect through the relay or Tailscale.
|
|
- [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.
|
|
- [Plugins](/docs/plugins), add trusted local surfaces, sidebar actions, daemon behavior, and composer attachments.
|
|
- [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.
|