> ## Documentation Index
> Fetch the complete documentation index at: https://docs.browserwire.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Quick Start
> Install the CLI, record a site, and make your first API call in under 5 minutes.
## 1. Install the CLI
```bash theme={null}
npm install -g @browserwire/cli
```
This installs the `bw` command globally. Playwright and Chromium are installed automatically via the `postinstall` script.
Requires **Node.js 22+** and **macOS or Linux**.
## 2. Create an account and log in
```bash theme={null}
bw login
```
Your default browser opens to the BrowserWire sign-in page. If you don't have an account yet, click **Sign up** to create one — you can sign up with email or an OAuth provider (Google, GitHub, etc.).
After you authenticate, the browser shows a "Logged in successfully!" confirmation and you can close the tab. Back in your terminal, you'll see:
```
Logged in as you@example.com
```
Your session token is saved locally and is valid for 30 days. You won't need to log in again until it expires.
If the browser doesn't open automatically, the CLI prints a URL you can copy and visit manually.
## 3. Record a site
```bash theme={null}
bw record https://example.com
```
A Chrome browser launches and navigates to the URL. You'll see this in your terminal:
```
Launching browser for https://example.com...
Navigate the site freely.
Press Enter to START recording, then Enter again to STOP.
```
Browse the site to get oriented — nothing is being captured yet.
When you're ready, **press Enter** in your terminal. BrowserWire reloads the page for a clean initial snapshot and starts capturing:
```
Reloading page for clean snapshot...
Recording started. Navigate the site, then press Enter to stop.
```
Now interact with the site — fill forms, click buttons, navigate between pages. Everything you do is captured as structured DOM events.
When you're done, **press Enter** again to stop:
```
Captured 847 events.
Uploading recording...
Upload complete.
Starting training...
Opening dashboard: https://app.browserwire.io/dashboard/recordings/abc123
```
The recording is uploaded automatically, training begins in the cloud, and your dashboard opens in the browser.
## 4. Monitor training on the dashboard
The dashboard opens to your **recording detail page**, where you can see:
* **Event count and timestamp** for the recording
* **Training status badge** — a live indicator showing the current state:
* **running** (with animated dot) — the AI is analyzing your recording
* **complete** — a manifest has been generated
* **error** — something went wrong (an error message is shown)
* **Recording Replay** — an interactive player that lets you replay your recorded session
Once training completes, a link appears next to the status badge pointing to the generated manifest (e.g., `→ example-com`). Click it to jump directly to your API endpoints.
Training typically takes 1–2 minutes. You can navigate away and come back — the status updates automatically.
## 5. Explore your generated API
Go to **APIs** in the dashboard sidebar. You'll see your newly generated manifest with the domain name and endpoint count.
Click the domain to open the **Endpoint Explorer**. Every discovered view and action is listed with:
* A **method badge** (`GET` for views, `POST` for actions)
* The **endpoint name** (e.g., `product_list`, `submit_login`)
* The **full URL path** for the local server
* A **copy-ready curl command** you can paste into your terminal
## 6. Start the local server
```bash theme={null}
bw run
```
```
BrowserWire execution server running on http://127.0.0.1:8787
Health: curl http://127.0.0.1:8787/api/health
Sites: curl http://127.0.0.1:8787/api/sites
Headed mode | Max concurrent: 3
```
A browser launches in the background. The server pre-fetches your manifests and is ready to serve requests.
## 7. Call your APIs
List discovered sites:
```bash theme={null}
curl http://127.0.0.1:8787/api/sites
```
Read a view (structured data from a page):
```bash theme={null}
curl http://127.0.0.1:8787/api/sites/example-com/views/HomePage/product_list
```
Execute an action:
```bash theme={null}
curl -X POST http://127.0.0.1:8787/api/sites/example-com/actions/LoginPage/submit_login \
-H "Content-Type: application/json" \
-d '{"email": "user@example.com", "password": "secret"}'
```
The slug (`example-com`) is the site's domain with dots replaced by hyphens. Check `GET /api/sites` to see all available slugs, or copy the curl commands directly from the dashboard's Endpoint Explorer.
## Next steps
Tips for getting the best results from recordings.
Connect your APIs to AI agents.
Full walkthrough of the web dashboard.
Full endpoint documentation.