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
Download Agent Installer
Download Agent Installer
- Log into your OpenAutomate dashboard
- Navigate to Agents → Add New Agent
- Download the Bot Agent installer for Windows
- Note down the Machine Key provided (you’ll need this for registration)
Install and Configure
Install and Configure
- Run the installer as Administrator
- Follow the installation wizard
- Launch the OpenAutomate Agent UI from the Start menu
- Enter your Machine Key and Organization Slug
- Click Register to connect to the cloud orchestrator
Step 3: Create Your First Bot
Create Bot from Template
Create Bot from Template
- Install cookiecutter:
pip install cookiecutter - Generate from template:
cookiecutter https://github.com/OpenAutomateOrg/openautomate-bot-template - Answer the prompts (bot name, description)
- Navigate to your generated bot project
Customize the Bot
Customize the Bot
Open
bot.py and modify the execute method:Upload Package
Upload Package
- Test locally:
python bot.py - Zip your bot folder (including
bot.py,requirements.txt, etc.) - In the dashboard, upload the ZIP file as a new package
- Add a name, description, and version number
- Click Save to store the package
Step 4: Execute Your First Automation
1
Create Execution
- Go to Executions → New Execution
- Select your uploaded package
- Choose the registered Bot Agent
- 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 support@openautomate.io
- GitHub: Report issues or contribute to the project