Automators Agent

Pre-requisites

Before you begin, ensure that you have pipx installed.

Note: Python 3.13 (which the default homebrew pipx install depends on) is not yet supported by us (see https://github.com/automators-com/agent/issues/7). We would suggest using pip install pipx in the interim.

You also need to have playwright installed:

pip install --upgrade pip
pip install playwright
playwright install

Installation

1. Install the agent using pipx:

python -m pipx install automators-agent

2. Initialize the agent:

agent init

3. Update the .env file to include an OpenAI API key. Edit the prompt in the config.toml file and then start the agent:

agent start

Setting up development environment

Clone the repository:

git clone https://github.com/automators-com/agent.git
cd agent

Install the dependencies:

uv sync --all-extras --dev

Install playwright:

playwright install chromium

Environment Variables

Create a .env file in the root of the project with the following content:

OPENAI_API_KEY=""
OPENAI_MODEL="gpt-4o"
HEADLESS=true
LOG_LEVEL="INFO"

Usage

Run the agent:

uv run agent