Mohamed BoudraandGitHub
7e46f6a647
* Rework docs navigation and move alternatives to top-level pages - Add nested docs nav with categories, collapsible groups, breadcrumbs, and a right-hand page outline with heading slugs. - Move alternatives out of /docs/alternatives into /alternatives/* marketing pages with 301 redirects. - Add github-slugger for heading IDs and require explicit width on SiteShell so new pages can't accidentally pick the narrow prose layout. - Remove the best-practices doc from public-docs. * Make docs content column prose-width
45 lines
1.8 KiB
Markdown
45 lines
1.8 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. Two 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 by scanning the QR code in Settings.
|
|
|
|
## 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 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` (defaults to `~/.paseo`).
|
|
|
|
## Where next
|
|
|
|
- [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.
|
|
- [CLI reference](/docs/cli), every command.
|
|
- [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.
|