Skip to main content

Start Building with Automagik

Choose Your Tool

The Automagik Suite provides 6 powerful tools for AI automation. Choose the one that fits your needs:

The Complete Stack

For the full experience, here’s how the tools work together:
1

Genie: Orchestrate Your Workspace

Start with Genie to set up your AI-ready workspace and manage your repository context.
npm install -g automagik-genie
genie init
2

Forge: Manage Tasks

Use Forge to create and organize AI-powered tasks with multi-LLM support.
npm install -g automagik-forge
forge init
forge task create "Build user authentication"
3

Hive: Deploy Agent Teams

Set up specialized agent teams to execute complex workflows.
pip install automagik-hive
hive init
hive start
4

Omni: Connect Channels

Enable agents to communicate via WhatsApp, Discord, Slack, and more.
pip install automagik-omni
omni init
omni serve
5

Spark: Automate Workflows

Schedule agents to work 24/7 with automated workflows.
pip install automagik-spark
spark init
spark start
6

Tools: Extend Capabilities

Generate MCP tools to connect any API to your AI agents.
uvx automagik-tools generate --spec https://api.example.com/openapi.json

Quick Wins

5-Minute Wins (Pick One)

# Install and start
pip install automagik-omni
omni init
omni serve

# Connect WhatsApp
omni instance create --name my-whatsapp
omni instance qr --name my-whatsapp
# Scan QR code with WhatsApp

# Send message
omni send --to "+1234567890" --message "Hello from Omni!"
✅ You just sent your first omnichannel message!
# Generate MCP tool from PetStore API
uvx automagik-tools generate \
  --spec https://petstore3.swagger.io/api/v3/openapi.json \
  --name petstore

# Serve it
uvx automagik-tools serve --tools petstore
✅ You just created an AI-ready API tool in 30 seconds!
# Install Forge
npm install -g automagik-forge
forge init

# Create task with multiple LLMs
forge task create \
  --title "Add dark mode toggle" \
  --llm claude

forge task fork 1 --llm gemini

# Compare results
forge task compare 1
✅ You just compared Claude vs Gemini on the same task!
# Install Spark
pip install automagik-spark
spark init

# Create workflow
cat > workflows/daily-report.yaml <<EOF
name: daily-report
schedule: "0 9 * * *"  # 9 AM daily
tasks:
  - name: generate-report
    type: script
    script: echo "Daily report generated!"
EOF

# Start scheduler
spark start
✅ You just automated a daily workflow!

Common Patterns

Pattern 1: AI-Powered Development Workflow

Use Case: Building features with AI assistance while keeping humans in control.

Learn This Pattern

Follow the Forge quickstart to see this in action

Pattern 2: Customer Support Automation

Use Case: AI-powered customer support across multiple channels.

Learn This Pattern

Follow the Omni quickstart to see this in action

Pattern 3: Automated Operations

Use Case: 24/7 automated operations and monitoring.

Learn This Pattern

Follow the Spark quickstart to see this in action

Prerequisites

Before getting started, ensure you have:
  • Node.js v18 or higher
  • npm or yarn
  • Git
  • Python 3.10 or higher
  • pip or uv
  • Virtual environment (recommended)
You’ll need API keys for the LLMs you want to use:

Need Help?


What’s Next?

Now that you know what’s available, dive into the tool that matches your needs: