docs: fix 6 documentation issues (#303, #245, #186, #134, #61, #73) (#486)

* docs: fix 6 documentation issues (#303, #245, #186, #134, #61, #73)

Addresses six open documentation issues in a single pass:

- **#303** -- Add `npx agent-browser` usage across README, SKILL.md, docs site, and `--help` output for zero-install experience. Global install is recommended as the fastest path (native Rust CLI vs Node.js indirection with npx).
- **#245** -- Document Claude Code skill installation with `npx skills add vercel-labs/agent-browser`
- **#186** -- Split installation instructions into Global (recommended), Quick Start (npx), and Project (local dependency) sections with clear guidance on when to use each
- **#134** -- Add "Why agent-browser over playwright-mcp?" comparison table to README covering output format, element selection, protocol, sessions, performance, mobile, cloud, and streaming
- **#61** -- Add "Timeouts and Slow Pages" section to SKILL.md documenting the 60s default timeout, all `wait` variants, and guidance for slow websites
- **#73** -- Replace stale `cp node_modules/...` advice with `npx skills add`, add warning against copying SKILL.md manually, add "Session Management and Cleanup" section to SKILL.md

* remove section

* fix doc
This commit is contained in:
Chris Tate
2026-02-16 22:14:43 -06:00
committed by GitHub
parent d441843cca
commit b7b0da5dfa
5 changed files with 146 additions and 21 deletions
+44 -4
View File
@@ -4,13 +4,43 @@ Headless browser automation CLI for AI agents. Fast Rust CLI with Node.js fallba
## Installation
### npm (recommended)
### Global Installation (recommended)
Installs the native Rust binary for maximum performance:
```bash
npm install -g agent-browser
agent-browser install # Download Chromium
```
This is the fastest option -- commands run through the native Rust CLI directly with sub-millisecond parsing overhead.
### Quick Start (no install)
Run directly with `npx` if you want to try it without installing globally:
```bash
npx agent-browser install # Download Chromium (first time only)
npx agent-browser open example.com
```
> **Note:** `npx` routes through Node.js before reaching the Rust CLI, so it is noticeably slower than a global install. For regular use, install globally.
### Project Installation (local dependency)
For projects that want to pin the version in `package.json`:
```bash
npm install agent-browser
npx agent-browser install
```
Then use via `npx` or `package.json` scripts:
```bash
npx agent-browser open example.com
```
### Homebrew (macOS)
```bash
@@ -752,7 +782,7 @@ The daemon starts automatically on first command and persists between commands f
### Just ask the agent
The simplest approach - just tell your agent to use it:
The simplest approach -- just tell your agent to use it:
```
Use agent-browser to test the login flow. Run agent-browser --help to see available commands.
@@ -760,7 +790,7 @@ Use agent-browser to test the login flow. Run agent-browser --help to see availa
The `--help` output is comprehensive and most agents can figure it out from there.
### AI Coding Assistants
### AI Coding Assistants (recommended)
Add the skill to your AI coding assistant for richer context:
@@ -768,7 +798,17 @@ Add the skill to your AI coding assistant for richer context:
npx skills add vercel-labs/agent-browser
```
This works with Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Goose, OpenCode, and Windsurf.
This works with Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Goose, OpenCode, and Windsurf. The skill is fetched from the repository, so it stays up to date automatically -- do not copy `SKILL.md` from `node_modules` as it will become stale.
### Claude Code
Install as a Claude Code skill:
```bash
npx skills add vercel-labs/agent-browser
```
This adds the skill to `.claude/skills/agent-browser/SKILL.md` in your project. The skill teaches Claude Code the full agent-browser workflow, including the snapshot-ref interaction pattern, session management, and timeout handling.
### AGENTS.md / CLAUDE.md