Skip to main content

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

Project description

AutomatiQ

Your activity, into automation.

Discord Python License

AutomatiQ

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

1. RECORD                      2. COMPILE                        3. AGENT
   Browse a website     ==>       AI analyses video      ==>        LLM investigates,
   normally                       clips & network                   writes & tests
                                  requests                          a Python script
  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

git clone https://github.com/StoneSteel27/AutomatiQ.git
cd AutomatiQ
pip install -e .

Dev setup

pip install -e ".[dev]"
pre-commit install

This installs ruff, build, twine, and pre-commit hooks (lint + format on every commit).

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.0.tar.gz (89.2 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.0-py3-none-any.whl (92.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for automatiq-0.1.0.tar.gz
Algorithm Hash digest
SHA256 402b152e567d4af148934d2b0040ab7a0aca9bb6efef178806e8775a84c55feb
MD5 938cd63fbfe492b059e0bc2ba05f0f33
BLAKE2b-256 2276b368c758d43d94cbd450d2ab91463998ef4d75b6634e3e1e7ff03424c371

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for automatiq-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 49ba6189857d58071fc7be4c409dfe41715ad6dad9254e84d5d6d7b5a8ac4d6b
MD5 10de6d0e51c082dd9b385a12f158de08
BLAKE2b-256 36e1b0711873b5a874ab21e820b6085e737b59af3031c9d2b850720d8860396b

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