Files
asensagent a42d58d92b docs: comprehensive audit fix for CLI 1.0.0–1.4.2 (#520)
* docs: comprehensive audit fix for CLI 1.0.0–1.4.2

Align docs/ and skills/ with CLI actual state after 1.0.0→1.4.2 changes.

P0 — broken examples fixed:
- quickstart.mdx: add --session/--tab, use start+goto instead of open
- index.mdx: replace search→get→operate flow with start→snapshot→automate
- api-reference/cli.mdx: remove search/get sections, add full browser
  command reference with --session/--tab on all commands
- guides/browser.mdx: add --session/--tab to Local Mode examples,
  replace search→get recommended workflow with snapshot-based workflow
- guides/cli-and-skills.mdx: add --session/--tab, update skill workflow
  from search→get→operate to start→snapshot→automate

P1 — missing flags and commands:
- command-reference.md: add --provider/-p, --stealth/--no-stealth,
  --header, --session to start; add --wait-until to goto; add --by-ref
  to select; add --no-isolate, pre-context fields, structured error
  details to eval; add --screenshot-format, --selector to screenshot;
  add hermes target and --browser to setup; remove --executable-path
- SKILL.md: add missing commands to Observation row (viewport, attr,
  attrs, box, styles, describe, state, inspect-point, pdf) and
  Interaction row (focus, drag, upload, eval, mouse-move,
  cursor-position); add cloud provider workflow section

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: restore search/get references per review feedback

Keep actionbook search and actionbook get sections in docs — they will
be adjusted later. Restores search/get to api-reference/cli.mdx,
index.mdx, browser.mdx recommended workflow, and cli-and-skills.mdx
core commands and skill workflow. The --session/--tab fixes on browser
commands remain.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: add select diagnostic output to command-reference

Document that `browser select` now returns structured diagnostics
(available values, visible texts, match mode, total count) when an
option is not found (PR #521).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-14 15:18:28 +08:00

56 lines
1.3 KiB
Plaintext

---
title: 'Quickstart'
description: 'Get started with Actionbook in minutes'
---
import InstallTabs from "/snippets/install-tabs.mdx";
Goal: run your first `actionbook browser` workflow with a working local setup in under 2 minutes.
## Quick Setup (CLI)
1. Install the CLI:
<InstallTabs />
2. Run the setup wizard (recommended):
```bash
actionbook setup
```
`setup` configures API key, browser mode, health checks, and optional agent skill installation in one flow.
3. Run your first browser commands:
```bash
actionbook browser start --set-session-id s1
actionbook browser goto "https://example.com" --session s1 --tab t1
actionbook browser snapshot --session s1 --tab t1
actionbook browser close --session s1
```
If `snapshot` returns the page structure, your local setup is ready.
## What You Have
- Actionbook CLI installed
- Local config written to `~/.actionbook/config.toml`
- Browser automation verified with `actionbook browser ...`
## Next Steps
<CardGroup cols={2}>
<Card
title="CLI & Skills Guide"
icon="terminal"
href="/guides/cli-and-skills"
>
Learn more about CLI commands and Skills
</Card>
<Card title="MCP Server (Optional)" icon="server" href="/guides/mcp-server">
Advanced IDE integration via MCP
</Card>
</CardGroup>