Quick Start

Quick Start Guide

Get autom8y running locally and execute your first workflow in minutes.

Prerequisites

Before you begin, ensure you have:

• Python 3.11 or later
• pip or uv package manager
• Git for cloning repositories
• AWS credentials configured (for charter integration)

Installation

1. Clone the core repository

   git clone https://github.com/autom8y/autom8.git
   cd autom8

2. Set up your environment

   uv (recommended)

   uv venv
   source .venv/bin/activate
   uv pip install -e .

   pip

   python -m venv .venv
   source .venv/bin/activate
   pip install -e .

3. Configure your environment

   Copy the example environment file and configure your settings:

   cp .env.example .env
   # Edit .env with your configuration

4. Verify installation

   autom8 --version

Your First Workflow

Once installed, you can run a simple workflow:

autom8 workflow run hello-world

Expected output:

[autom8] Starting workflow: hello-world
[autom8] Step 1/1: Greeting
[autom8] Hello, autom8y!
[autom8] Completed in 0.1s

Project Structure

After cloning, you’ll see this structure:

autom8/
├── src/
│   └── autom8/
│       ├── cli/          # Command-line interface
│       ├── workflows/    # Workflow definitions
│       └── integrations/ # System integrations
├── tests/                # Test suite
├── pyproject.toml        # Project configuration
└── README.md

Next Steps

Now that you have autom8y running:

• Learn about the Architecture to understand how components interact
• Review API Standards for building integrations
• Explore the GitHub repositories for more tools
• Browse the Auth API Reference for detailed endpoint documentation
• Try the API Explorer to test endpoints interactively

Troubleshooting

Common Issues

autom8: command not found

Ensure your virtual environment is activated and the package is installed:

source .venv/bin/activate
pip show autom8

AWS credentials not found

If using charter for secrets, ensure AWS credentials are configured:

aws configure list

Need more help? Check the GitHub issues or open a new one.