From fd030e8673ebb42afb87945df6ecb12ba8fab888 Mon Sep 17 00:00:00 2001 From: Mohamed Boudra Date: Sun, 29 Mar 2026 22:37:53 +0700 Subject: [PATCH] docs: clarify installation paths and components (#153) Rewrite Getting Started in README and website docs to explain the daemon, put agent CLI prerequisites first, and split setup into Desktop App (recommended, bundles daemon) and CLI/headless paths. Add "Components at a glance" section to ARCHITECTURE.md. --- README.md | 22 ++++-- docs/ARCHITECTURE.md | 8 ++ packages/website/src/routes/docs/index.tsx | 87 +++++++++++++++------- 3 files changed, 87 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 3936c9a9b..a43cf0b4f 100644 --- a/README.md +++ b/README.md @@ -26,20 +26,32 @@ Run agents in parallel on your own machines. Ship from your phone or your desk. ## Getting Started -### Desktop app +Paseo runs a local server called the daemon that manages your coding agents. Clients like the desktop app, mobile app, web app, and CLI connect to it. -Download from [paseo.sh/download](https://paseo.sh/download) or the [GitHub releases page](https://github.com/getpaseo/paseo/releases). The app bundles its own daemon, so there's nothing else to install. It can also connect to daemons running on other machines. +### Prerequisites -### Headless / server mode +You need at least one agent CLI installed and configured with your credentials: -Run the daemon on any machine: +- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) +- [Codex](https://github.com/openai/codex) +- [OpenCode](https://github.com/anomalyco/opencode) + +### Desktop app (recommended) + +Download it from [paseo.sh/download](https://paseo.sh/download) or the [GitHub releases page](https://github.com/getpaseo/paseo/releases). Open the app and the daemon starts automatically. Nothing else to install. + +To connect from your phone, scan the QR code shown in Settings. + +### CLI / headless + +Install the CLI and start Paseo: ```bash npm install -g @getpaseo/cli paseo ``` -Then connect from any client — desktop, web, mobile, or CLI. See [paseo.sh/download](https://paseo.sh/download) for all options. +This shows a QR code in the terminal. Connect from any client. This path is useful for servers and remote machines. For full setup and configuration, see: - [Docs](https://paseo.sh/docs) diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index c2f29dcf0..fe783703e 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -31,6 +31,14 @@ Your code never leaves your machine. Paseo is local-first. └───────────┘ └────────┘ └──────────┘ ``` +## Components at a glance + +- **Daemon:** Local server that spawns and manages agent processes and exposes the WebSocket API. +- **App:** Cross-platform Expo client for iOS, Android, web, and the shared UI used by desktop. +- **CLI:** Terminal interface for agent workflows that can also start and manage the daemon. +- **Desktop app:** Electron wrapper around the web app that bundles and auto-manages its own daemon. +- **Relay:** Optional encrypted bridge for remote access without opening ports directly. + ## Packages ### `packages/server` — The daemon diff --git a/packages/website/src/routes/docs/index.tsx b/packages/website/src/routes/docs/index.tsx index 2c09965bb..6a98d075c 100644 --- a/packages/website/src/routes/docs/index.tsx +++ b/packages/website/src/routes/docs/index.tsx @@ -17,37 +17,17 @@ function GettingStarted() {

Getting Started

- Paseo connects to your local development environment and lets you manage your coding - agents from anywhere. + Paseo has three main pieces: the daemon is the local server that manages your agents, + the app is the client you use from mobile, web, or desktop, and the CLI is the terminal + interface that can also launch the daemon.

-
-

Installation

-

Install the CLI globally and run it on your machine:

-
- $ - npm install -g @getpaseo/cli -
-
- $ - paseo -
-
- -
-

Connect the App

-

- Open Paseo on your phone and scan the QR code displayed in your terminal, or enter the - server address manually. -

-
-

Prerequisites

- Paseo wraps CLI tools like Claude Code and Codex. You'll need to have them installed and - configured with your own credentials before Paseo can manage them. + Paseo manages existing agent CLIs. Install at least one agent and make sure it already + works with your credentials before you set up Paseo.

+
+

Desktop App

+

+ Download the desktop app from{" "} + + paseo.sh/download + {" "} + or the{" "} + + GitHub releases page + + . Open it and you're done. +

+

+ The desktop app bundles and manages its own daemon automatically, so you do not need a + separate CLI install on that machine unless you want it. +

+

+ On first launch, you may briefly see a startup screen while the local server starts and + the app connects to it. After that, connect from your phone by scanning the QR code in + Settings if you want mobile access. +

+
+ +
+

CLI / Server

+

+ Use this path for headless setups, servers, or remote machines where you want the daemon + running without the desktop app. +

+
+ $ + npm install -g @getpaseo/cli +
+
+ $ + paseo +
+

+ Paseo prints a QR code in the terminal. Scan it from the mobile app, or enter the daemon + address manually from another client. +

+

+ Configuration and local state live under PASEO_HOME. +

+
+

Voice Setup