Skip to content
Bflow

Quick Start

🚀 Quick Start

Section titled “🚀 Quick Start”

Get started with Bflow in two minutes.

📋 Prerequisites

Section titled “📋 Prerequisites”

Before you begin, ensure you have:

  1. Bun (version 1.1 or higher) installed on your machine.
  2. Google Chrome or Chromium installed locally.

📦 Step 1: Install Dependencies

Section titled “📦 Step 1: Install Dependencies”

Clone the repository and install dependencies with Bun:

Terminal window
git clone https://github.com/KhBayazidAhmed/browser-automation-cli.git
cd browser-automation-cli
bun install

⚡ Step 2: Launch the Studio (The Easy Way)

Section titled “⚡ Step 2: Launch the Studio (The Easy Way)”

The simplest and most user-friendly way to use the CLI is the Interactive Terminal Studio:

Terminal window
bun cli

bun dev starts every development workspace in the monorepo. Use bun cli when you only want the automation studio.

You will see an interactive prompt:

┌  ⚡ Browser Automation Studio
│
◇  What would you like to do?
│  ● 🌊 Run a Workflow
│  ○ 🔴 Record New Workflow
│  ○ 🚀 Run Programmatic Task
│  ○ 💬 Open Interactive Browser REPL
│  ○ 📁 View Extracted Data & Outputs
│  ○ ❌ Exit

Use your arrow keys and press Enter to choose an action.

🔴 Step 3: Record Your First Workflow

Section titled “🔴 Step 3: Record Your First Workflow”

To visually record a new automation flow in Chrome:

Terminal window
bun record workflows/my-first-flow.json https://news.ycombinator.com
  1. Chrome will open with the In-Page Floating HUD Toolbar.
  2. Click on elements, type into search boxes, or press 🔍 Extract / 📊 List to extract data.
  3. Click 🛑 Finish (or press f / Enter in the terminal) to save your workflow to workflows/my-first-flow.json.

🌊 Step 4: Replay Your Workflow

Section titled “🌊 Step 4: Replay Your Workflow”

Execute the recorded workflow anytime from the command line:

Terminal window
# Run headless (fast, in the background)
bun flow workflows/my-first-flow.json


# Run headed (watch Chrome execute live in a window)
bun flow workflows/my-first-flow.json --headed

🛠️ Step 5: Try the Interactive Browser REPL

Section titled “🛠️ Step 5: Try the Interactive Browser REPL”

Need to inspect a webpage or test CDP commands interactively? Launch the REPL:

Terminal window
bun repl
cdp> goto https://example.com
✓ Loaded (210ms)
cdp> title
Title: Example Domain
cdp> screenshot output/example.png
✓ Saved screenshot (18.4 KB) to output/example.png
cdp> exit

📚 What’s Next?

Section titled “📚 What’s Next?”