Skip to main content
Get AutoMFlows up and running in minutes and create your first browser automation workflow.

Prerequisites

Before you begin, ensure you have Node.js 20 or newer installed on your system.
node -v   # should be v20.x.x or higher
npm -v
If you don’t have Node.js 20+, see the Installation guide for detailed setup instructions.

Installation

1

Clone the repository

Clone the AutoMFlows repository from GitHub:
git clone https://github.com/ashxtrem/AutoMFlows.git
cd AutoMFlows
2

Install dependencies

Install all workspace dependencies using npm:
npm install
This installs dependencies for all workspaces: backend, frontend, shared, and mcp-server.
3

Build the shared package

The shared package contains TypeScript types and utilities used across the monorepo:
cd shared && npm run build && cd ..
4

Start the application

Use the provided startup scripts to launch both backend and frontend servers:
./start.sh
The startup script will:
  • Install Playwright browsers (Chromium, Firefox, WebKit)
  • Start the backend server on port 3003
  • Start the frontend server on port 5173
  • Display the URLs for accessing the application
The first startup may take a few minutes as Playwright downloads browser binaries.

Access the Application

Once the servers are running, you can access:

Frontend UI

Visual workflow builder at http://localhost:5173

Backend API

API server at http://localhost:3003

Swagger Docs

API documentation at http://localhost:3003/api-docs
Add --host or --lan flag to the startup script to access AutoMFlows from other devices on your network:
./start.sh --lan
The script will display your LAN IP address for access from other devices.

Create Your First Workflow

Now that AutoMFlows is running, let’s create a simple browser automation workflow:
1

Open the workflow builder

Navigate to http://localhost:5173 in your browser. You’ll see the visual workflow editor with a sidebar of available nodes.
2

Add a Start node

The Start node is the entry point for every workflow. It should already be on the canvas. If not, drag it from the Browser category in the sidebar.
3

Add a Navigate node

  1. Drag the Navigate node from the Browser category onto the canvas
  2. Connect the Start node’s output port to the Navigate node’s input port
  3. Click the Navigate node to configure it in the right sidebar
  4. Enter a URL, for example: https://example.com
4

Add a Screenshot node

  1. Drag the Screenshot node from the Data category onto the canvas
  2. Connect the Navigate node’s output to the Screenshot node’s input
  3. Configure the screenshot settings in the right sidebar (optional)
5

Run the workflow

Click the Run button in the top toolbar. You’ll see:
  • Nodes highlight in real-time as they execute
  • A browser window opens and navigates to your URL
  • A screenshot is captured and saved
  • Execution results appear in the results panel
AutoMFlows uses Playwright for browser automation, supporting Chromium, Firefox, and WebKit.

Available Node Types

AutoMFlows provides 20+ node types organized into categories:

Browser

Start, Open Browser, Navigate - Control browser lifecycle and navigation

Interaction

Click, Type - Interact with page elements

Data

Get Text, Screenshot - Extract data from pages

Verification

Verify - Validate browser and API responses

API

API Request, API cURL - Make HTTP requests

Control

Wait, Loop - Control execution flow

Value

Int, String, Boolean, Input Value - Define workflow values

Config

Load Config File, Select Config File - Load configuration data

Code

JavaScript Code - Execute custom JavaScript
The JavaScript Code node executes arbitrary code on the server. Only use AutoMFlows in trusted environments.

Save and Load Workflows

Workflows can be saved and loaded as JSON files:
  1. Click the Save button to export your workflow as JSON
  2. Click the Load button to import a previously saved workflow
  3. Share workflow files with team members or use version control

View Results and Reports

After execution, you can:
  • View node execution results in the results panel
  • Check screenshots in the screenshots directory
  • Generate reports in multiple formats:
    • HTML
    • Allure
    • JSON
    • JUnit XML
    • CSV
    • Markdown

Next Steps

Installation

Detailed installation guide for all platforms

Node Types

Learn about all available node types and their configurations

Advanced Features

Explore retry strategies, wait options, and plugin system

Plugin Development

Create custom nodes to extend AutoMFlows functionality

Troubleshooting

If ports 3003 or 5173 are already in use, the startup script will attempt to stop existing processes. If this fails, manually kill the processes or change the port in the configuration.
If Playwright browsers fail to install automatically, manually install them:
cd backend
npx playwright install chromium
Ensure you have TypeScript installed and Node.js 20+. Try cleaning and rebuilding:
cd shared
rm -rf dist node_modules
npm install
npm run build
For more help, check the GitHub repository or review server logs for detailed error messages.

Build docs developers (and LLMs) love