Skip to main content
Get up and running with Hyrex in minutes.

Prerequisites

  • Python 3.11 or higher
  • PostgreSQL 12+ (for FOSS) or Hyrex Cloud account

1. Install Hyrex

2. Initialize a New Project

Use the interactive hyrex init command to set up a new project:
This will guide you through:
  • Choosing a project name
  • Selecting between PostgreSQL (self-hosted) or Hyrex Cloud
  • Creating project files (.env, hyrex_app.py, tasks.py, requirements.txt, Dockerfile)
For manual database initialization (if needed):

3. Project Structure

After running hyrex init, you’ll have:
Example tasks.py:

4. Send Tasks

Queue tasks for execution:

5. Run Workers

Start workers to process tasks:

6. Monitor Tasks

Visit your dashboard at hyrex.io/cloud to monitor tasks in real-time.

Next Steps

Tasks

Learn about task configuration

Workflows

Build complex workflows

Examples

See real-world patterns

Production Guide

Deploy to production