Skip to main content

​
CLI Reference

The Actionbook CLI (actionbook) is the primary interface for interacting with Actionbook. Search for available action manuals. Usage: 
actionbook search [query]
Arguments:
  • query: The search keyword (e.g., “airbnb”, “google login”).
Example: 
actionbook search "airbnb search"

​
actionbook get

Retrieve a specific action manual by its ID. Usage: 
actionbook get [actionId]
Arguments:
  • actionId: The unique identifier of the action.
Example: 
actionbook get "site/airbnb.com/page/home/element/search-button"

​
actionbook setup

Initial setup wizard for API key, browser preferences, health checks, and optional skills install. Run this once, then use the same actionbook browser ... commands regardless of mode. Usage: 
actionbook setup

​
actionbook browser

Browser automation commands.
After actionbook setup, browser command syntax is identical across modes.

​
actionbook browser open

Open a URL in the browser. Usage: 
actionbook browser open [url]

​
actionbook browser click

Click an element on the current page. Usage: 
actionbook browser click [selector]
Arguments:
  • selector: The CSS selector, XPath, or other supported selector string.

​
actionbook browser fill

Fill an input field with text. Usage: 
actionbook browser fill [selector] [value]
Arguments:
  • selector: The target input element selector.
  • value: The text value to input.

​
Global Flags

These flags apply to all actionbook browser subcommands:
  • --json — Output results in JSON format.

​
actionbook app

Automate desktop applications built with Electron (VS Code, Slack, Discord, Figma, Notion, Spotify, etc.) using Chrome DevTools Protocol.
All browser commands work with app prefix. Full feature parity with 35+ automation commands.

​
App-Specific Commands

​
actionbook app launch

Auto-discover and launch an Electron application. Usage: 
actionbook app launch [name]
Arguments:
  • name: The application name (e.g., “Visual Studio Code”, “Slack”, “Discord”).
Example: 
actionbook app launch "Visual Studio Code"
actionbook app launch Slack

​
actionbook app attach

Attach to a running Electron app by name, port, or WebSocket URL. Usage: 
actionbook app attach <target>
Arguments:
  • target (required): Application name, bundle ID, CDP port, or WebSocket URL.
Example: 
actionbook app attach 9222

​
actionbook app list

List all discoverable Electron applications on the system. Usage: 
actionbook app list

​
actionbook app status

Show current app connection status. Usage: 
actionbook app status

​
actionbook app close

Close the connected application. Usage: 
actionbook app close

​
actionbook app restart

Restart the application (preserves session). Usage: 
actionbook app restart

​
All Browser Commands Available

Every browser command works with the app prefix. This includes: Navigation:
  • actionbook app goto <URL>
Interaction:
  • actionbook app click <SELECTOR>
  • actionbook app type <TEXT> [SELECTOR]
  • actionbook app fill <TEXT> [SELECTOR]
  • actionbook app hotkey "Control+C"
Analysis:
  • actionbook app snapshot [--format compact]
  • actionbook app screenshot output.png
  • actionbook app eval "document.title"
Tab Management:
  • actionbook app tab list
  • actionbook app tab new
  • actionbook app tab switch <PAGE_ID>
Advanced Features:
  • Shadow DOM support (:shadow-root selector)
  • IFrame context switching
  • Keyboard hotkeys (single and multi-modifier)
  • Scroll with wait for lazy-loaded content
See the App Automation Guide for detailed examples and workflows.

​
Supported Applications

ApplicationmacOSLinuxWindows
Visual Studio Code✅✅✅
Slack✅✅✅
Discord✅✅✅
Figma✅✅✅
Notion✅✅✅
Spotify✅✅✅
Any Electron App✅✅✅