Skip to main content

Record browser sessions and reverse-engineer them into automation scripts.

Project description

AutomatiQ

Your activity, into automation.

Discord Python License

Test Status Lint Status

AutomatiQ

[!Note] Alpha 🡒 Things will break and change. Read VISION.md to understand why Automatiq exists and where it's headed.

AutomatiQ watches you browse, then an AI agent reverse-engineers your session into a standalone Python automation/extraction script; no manual inspection needed.

What it does

AutomatiQ

  1. Record ⭢ Opens Chrome, captures your browsing (screen video, network requests, user actions). Press Ctrl+C when you're done.
  2. Compile ⭢ Vision AI analyses video clips around each action; network requests are decoded, deduplicated, and structured into a workspace dump.
  3. Agent ⭢ An LLM investigator reads the workspace, experiments in a sandboxed IPython environment, and iteratively produces a working script.

Quick start

pip install automatiq

Set your API key (any litellm-supported model):

GEMINI_API_KEY=your-key-here

Run:

automatiq run https://example.com

That's it. Browse the site, press Ctrl+C, and the agent takes over.

Keyboard shortcuts

Phase Key Action
Recording Ctrl+C Stop recording and save session
Compilation Esc Skip AI analysis for remaining segments
Compilation y / n Confirm or deny the skip prompt
Agent q Quit the agent session
Agent Esc Cancel current LLM call or code execution

Ctrl+C force-quits at any phase.

CLI options

Flag Description
--model MODEL LiteLLM model string for the agent
--recorder-model MODEL Vision model for video-clip analysis
--base-url URL Custom OpenAI-compatible API endpoint
--max-steps N Maximum agent loop iterations (default: 60)
--sandbox-timeout SEC Seconds per IPython cell (default: 60)
--output-dir PATH Root directory for all output (default: ./output)
--no-banner Skip the startup animation
--verbose Show detailed diagnostic output
-V, --version Show version
-h, --help Show help message

How it works

  • Browser capture — Chrome is launched with CDP instrumentation. Every network request, response body, cookie, and user interaction (clicks, typing, navigation) is recorded with timestamps.
  • Vision analysis — The recording is split into per-action video clips. A vision LLM watches each clip and produces structured annotations (what was clicked, what changed, whether the action succeeded).
  • Sandboxed agent — The investigator runs Python code in an isolated IPython worker process. It can read the captured data, test hypotheses against the live site, and build the final script incrementally, with guardrails against loops and repetition.

Configuration

On first run, AutomatiQ creates ~/.automatiq/config.toml with commented defaults. Edit it to override models, timeouts, recording settings, etc.

[models]
agent    = "gemini/gemini-3-flash-preview"
recorder = "gemini/gemini-3.1-flash-lite-preview"
# base_url = "http://localhost:11434/v1"   # Ollama / LM Studio / vLLM

[agent]
max_steps       = 60
sandbox_timeout = 60

[recording]
fps                   = 3
segment_pad           = 2
merge_gap_threshold   = 1.5
max_frames_per_prompt = 8

Priority: CLI flag > ~/.automatiq/config.toml > built-in defaults.

Step-by-step usage

automatiq record https://example.com   # just record
automatiq agent                         # build automation script from last recording

Install from source

AutomatiQ is managed using uv.

git clone https://github.com/StoneSteel27/AutomatiQ.git
cd AutomatiQ
uv sync
uv run automatiq run https://example.com

Dev setup

Development dependencies (pytest, ruff, pre-commit, etc.) are installed automatically when you run uv sync. To set up the git hooks:

uv sync
uv run pre-commit install

Run tests and benchmarks:

uv run pytest

This ensures ruff, build, twine, pytest, and pre-commit hooks (lint + format on every commit) are properly configured in your isolated environment.

Requirements

  • Python 3.11+
  • A supported LLM API key (Gemini, OpenAI, OpenRouter, or any OpenAI-compatible endpoint via --base-url)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

automatiq-0.1.2.tar.gz (90.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

automatiq-0.1.2-py3-none-any.whl (96.3 kB view details)

Uploaded Python 3

File details

Details for the file automatiq-0.1.2.tar.gz.

File metadata

  • Download URL: automatiq-0.1.2.tar.gz
  • Upload date:
  • Size: 90.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for automatiq-0.1.2.tar.gz
Algorithm Hash digest
SHA256 7fba7e80b509ce6fc6497ed83dc72682fb3ebe8585c311d31985ceed8c7f6921
MD5 e55545604963c05d71cdfe737567688a
BLAKE2b-256 a67a5d2048069954ec6fbca1c354b4aad3bc683ecf0106a1c307b5cf272b5079

See more details on using hashes here.

File details

Details for the file automatiq-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: automatiq-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 96.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for automatiq-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 50692249717e463299850728450797c67fc3a1de817948e01895340576f6cfd6
MD5 fd23c40e9ade864110105f0110da9a1e
BLAKE2b-256 965160eeb232cc3ae7f3dda439e8c12007d04c8aa549e9e84399b30fa0e93c9a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page