Skip to main content

Installation

Get HackAgent up and running in seconds.

Quick Install​

Requirements​

  • Python 3.10+
  • pip

Production Installation​

python3 -m venv .venv
source .venv/bin/activate
pip install hackagent

Verify Installation​

After installation, verify everything works:

hackagent --version

Initial Setup​

HackAgent supports both local and remote modes:

  • Local mode (default): no API key required, results stored in ~/.local/share/hackagent/hackagent.db
  • Remote mode (cloud): set HACKAGENT_API_KEY (or --api-key) to sync runs to the HackAgent platform

Run the interactive setup wizard to configure preferences:

hackagent init

This will guide you through:

  1. Choose mode — Local (no API key) or Remote (cloud sync)
  2. Configure remote credentials (optional) — API key when Remote mode is enabled
  3. Set verbosity level — Control logging detail (0=ERROR to 3=DEBUG)
  4. Save configuration — Stored in ~/.config/hackagent/config.json
Local and Remote

By default, HackAgent runs locally and stores results in SQLite (~/.local/share/hackagent/hackagent.db).

To enable remote sync and cloud features, configure:

export HACKAGENT_API_KEY="your_api_key"
# optional
export HACKAGENT_BASE_URL="https://api.hackagent.dev"

You can also configure these values interactively with:

hackagent init

Or set them later without re-running the wizard:

hackagent config set --api-key YOUR_KEY
hackagent config set --base-url https://api.hackagent.dev

In remote mode, results are synchronized to the HackAgent platform while local mode remains available.

hackagent web follows the selected mode:

  • Local mode: launches the local dashboard server (http://127.0.0.1:7860 by default)
  • Remote mode: opens https://app.hackagent.dev

Next Steps​