Skip to main content

​
Quick Start Guide

This guide will help you set up OpenAutomate and run your first automation in under 10 minutes.

​
Prerequisites

Before you begin, ensure you have:
  • Windows 10/11 or Windows Server 2019+
  • Python 3.11 or higher installed
  • Cookiecutter for creating bot projects: pip install cookiecutter
  • Administrator access to install the Bot Agent
  • An active internet connection

​
Step 1: Create Your Organization

1

Sign Up

Visit cloud.openautomate.io and create your account.
2

Create Organization

Set up your organization unit with a unique name and slug.
3

Verify Email

Check your email and verify your account to activate full features.

​
Step 2: Install Bot Agent

  1. Log into your OpenAutomate dashboard
  2. Navigate to Agents → Add New Agent
  3. Download the Bot Agent installer for Windows
  4. Note down the Machine Key provided (you’ll need this for registration)
  1. Run the installer as Administrator
  2. Follow the installation wizard
  3. Launch the OpenAutomate Agent UI from the Start menu
  4. Enter your Machine Key and Organization Slug
  5. Click Register to connect to the cloud orchestrator

​
Step 3: Create Your First Bot

  1. Install cookiecutter: pip install cookiecutter
  2. Generate from template: cookiecutter https://github.com/OpenAutomateOrg/openautomate-bot-template
  3. Answer the prompts (bot name, description)
  4. Navigate to your generated bot project
Open bot.py and modify the execute method:
def execute(self):
    """
    Add your automation code here!
    """
    self.logger.info("🤖 Starting my automation...")
    
    # Update status
    self.update_status("Running Hello World automation")
    
    # Your automation logic here
    print("Hello from OpenAutomate!")
    
    return {
        'message': '✅ Hello World completed!',
        'data': {'greeting': 'Hello from OpenAutomate!'}
    }
  1. Test locally: python bot.py
  2. Zip your bot folder (including bot.py, requirements.txt, etc.)
  3. In the dashboard, upload the ZIP file as a new package
  4. Add a name, description, and version number
  5. Click Save to store the package

​
Step 4: Execute Your First Automation

1

Create Execution

  1. Go to Executions → New Execution
  2. Select your uploaded package
  3. Choose the registered Bot Agent
  4. Click Execute Now
2

Monitor Progress

Watch the real-time execution status in the dashboard. You’ll see:
  • Package download progress
  • Execution start notification
  • Live status updates from your bot
  • Completion confirmation
3

View Results

Check the execution logs and results in the Execution History section.

​
Next Steps

Congratulations! You’ve successfully set up OpenAutomate and run your first automation. Here’s what to explore next:

Build Advanced Bots

Learn to create more sophisticated automations using our Python SDK

Schedule Automations

Set up recurring executions with flexible scheduling options

Manage Assets

Securely store and access credentials in your automations

Monitor Performance

Track automation performance and success rates

​
Need Help?

  • Documentation: Browse our comprehensive guides
  • Community: Join our Discord server for support
  • Support: Contact us at [email protected]
  • GitHub: Report issues or contribute to the project