mirror of
https://github.com/actionbook/actionbook.git
synced 2026-09-19 03:28:06 +08:00
Adcent
161 lines
5.3 KiB
Markdown
161 lines
5.3 KiB
Markdown
|
|
|
|
<div align="center">
|
|
|
|
### Actionbook
|
|
|
|
 [](https://www.npmjs.com/package/@actionbookdev/cli) [](https://www.npmjs.com/package/@actionbookdev/cli) [](https://skills.sh/actionbook/actionbook/actionbook)
|
|
|
|
|
|
|
|
|
|
**Browser Action Engine for AI Agents**
|
|
<br />
|
|
Actionbook provides up-to-date action manuals and DOM structure,
|
|
<br />
|
|
so your agent operates any website instantly without guessing.
|
|
|
|
[Website](https://actionbook.dev) · [GitHub](https://github.com/actionbook/actionbook) · [X](https://x.com/ActionbookHQ) · [Discord](https://actionbook.dev/discord)
|
|
|
|
</div>
|
|
|
|
<br />
|
|
|
|
## Table of Contents
|
|
|
|
- [Why Actionbook?](#why-actionbook)
|
|
- [Quick Start](#quick-start)
|
|
- [Installation](#installation)
|
|
- [Examples](#examples)
|
|
- [Available Tools](#available-tools)
|
|
- [Documentation](#documentation)
|
|
- [Contributing](#contributing)
|
|
|
|
## Why Actionbook?
|
|
|
|
### ❌ Without Actionbook
|
|
|
|
Building reliable browser agents is difficult and expensive:
|
|
|
|
- **Slow Execution:** Agents waste time parsing full HTML pages to find elements.
|
|
- **High Token Costs:** Sending entire DOM trees to LLMs consumes massive context windows.
|
|
- **Brittle Selectors:** Updates to website UIs break hardcoded selectors and agent logic immediately.
|
|
- **Hallucinations:** LLMs often guess incorrect actions when faced with complex, unstructured DOMs.
|
|
|
|
### ✅ With Actionbook
|
|
|
|
Actionbook places up-to-date action manuals with the relevant DOM selectors directly into your LLM's context.
|
|
|
|
- **10x Faster:** Agents access pre-computed "Action manuals" to know exactly what to do without exploring.
|
|
- **100x Token Savings:** Instead of whole HTML page, agents receive only related DOM elements in concise, semantic JSON definitions.
|
|
- **Resilient Automation:** Action manuals are maintained and versioned. If a site changes, the manual is updated, not your agent.
|
|
- **Universal Compatibility:** Works with any LLM (OpenAI, Anthropic, Gemini) and any AI operator framework.
|
|
|
|
See how Actionbook enables an agent to complete an Airbnb search task 10x faster.
|
|
|
|
https://github.com/user-attachments/assets/9f896fe7-296a-44b3-8592-931a099612de
|
|
|
|
## Quick Start
|
|
|
|
Get started with Actionbook in under 2 minutes:
|
|
|
|
**Step 1: Install the CLI**
|
|
|
|
macOS / Linux
|
|
```bash
|
|
curl -fsSL https://actionbook.dev/install.sh | bash
|
|
```
|
|
|
|
Windows (PowerShell)
|
|
```
|
|
irm https://actionbook.dev/install.ps1 | iex
|
|
```
|
|
|
|
The Rust-based CLI uses your existing system browser (Chrome, Brave, Edge, Arc, Chromium), so no extra browser install step is required.
|
|
|
|
**Step 2: Use with any AI Agent**
|
|
|
|
When working with any AI coding assistant (Claude Code, Cursor, etc.), add this to your prompt:
|
|
|
|
```
|
|
Use Actionbook to understand and operate the web page.
|
|
```
|
|
|
|
The agent will automatically use the CLI to fetch action manuals and execute browser operations.
|
|
|
|
**Step 3 (Optional): Add the Skill**
|
|
|
|
For enhanced agent integration, add the Actionbook skill:
|
|
|
|
```bash
|
|
npx skills add actionbook/actionbook
|
|
```
|
|
|
|
## Installation
|
|
|
|
### macOS / Linux
|
|
|
|
```bash
|
|
curl -fsSL https://actionbook.dev/install.sh | bash
|
|
```
|
|
|
|
### Windows
|
|
|
|
```powershell
|
|
irm https://actionbook.dev/install.ps1 | iex
|
|
```
|
|
|
|
### npm
|
|
|
|
```bash
|
|
npm install -g @actionbookdev/cli
|
|
```
|
|
|
|
### Setup
|
|
|
|
```bash
|
|
actionbook setup
|
|
```
|
|
|
|
For more install options (Homebrew, from source) and upgrade instructions, see the [Installation Guide](https://actionbook.dev/docs/guides/installation).
|
|
|
|
The CLI is all you need to get started. For advanced use cases, Actionbook also offers an [MCP Server](https://actionbook.dev/docs/guides/mcp-server) and [JavaScript SDK](https://actionbook.dev/docs/guides/sdk-integration).
|
|
|
|
|
|
## Examples
|
|
|
|
Explore real-world examples in the [Examples Documentation](https://actionbook.dev/docs/examples).
|
|
|
|
|
|
## Available Tools
|
|
|
|
Actionbook provides tools for searching and retrieving action manuals. See the [CLI Reference](https://actionbook.dev/docs/api-reference/cli) for the full command list. If you're using the MCP integration, see the [MCP Tools Reference](https://actionbook.dev/docs/api-reference/mcp-tools).
|
|
|
|
|
|
## Documentation
|
|
|
|
For comprehensive guides, API references, and tutorials, visit our documentation site:
|
|
|
|
**[actionbook.dev/docs](https://actionbook.dev/docs)**
|
|
|
|
## Stay tuned
|
|
|
|
We move fast. Star Actionbook on Github to support and get latest information.
|
|
|
|
|
|
|
|
Join the community:
|
|
|
|
- [Chat with us on Discord](https://actionbook.dev/discord) - Get help, share your agents, and discuss ideas
|
|
- [Follow @ActionbookHQ on X](https://x.com/ActionbookHQ) - Product updates and announcements
|
|
|
|
## Contributing
|
|
|
|
- **[Read the Contributing Guide](CONTRIBUTING.md)** - See repository setup, package layout, and validation workflows for the public repo.
|
|
- **[Request a Website](https://actionbook.dev/request-website)** - Suggest websites you want Actionbook to index.
|
|
- **[Join the Waitlist](https://actionbook.dev)** - We are currently in private beta. Join if you are interested in contributing or using Actionbook.
|
|
|
|
## License
|
|
|
|
See [LICENSE](LICENSE) for the license details.
|