Skip to main content

​
Overview

Erdo provides multiple ways to get started, depending on your use case and preferences. This guide covers installation of the CLI, SDK, and platform access.

​
Erdo CLI

The CLI is the fastest way to build and deploy Erdo agents. 
brew install erdoai/tap/erdo

​
Manual Installation

Download the latest release for your platform: 
curl -L https://github.com/erdoai/homebrew-tap/releases/latest/download/erdo-cli_Darwin_x86_64.zip -o erdo-cli.zip
unzip erdo-cli.zip
chmod +x erdo
sudo mv erdo /usr/local/bin/
rm erdo-cli.zip

​
Verify Installation

erdo --version

​
Python SDK

Install the Erdo Python SDK for pure Python workflows - sync, test, and invoke agents all from Python without needing the CLI. 
pip install erdo

​
Verify SDK Installation

import erdo
from erdo.sync import Sync
from erdo.invoke import Invoke

print(f"Erdo SDK version: {erdo.__version__}")
print("SDK modules available: sync, invoke, test")

​
SDK Configuration

The SDK uses the same configuration as the CLI, reading from ~/.erdo/config.yaml or environment variables: 
from erdo.config import Config

# Automatically loads from ~/.erdo/config.yaml or env vars
config = Config()
print(f"API URL: {config.api_url}")
print(f"Authenticated: {config.is_authenticated()}")

​
Platform Access

​
Create Account

  1. Go to erdo.ai
  2. Sign up for a free account
  3. Verify your email address

​
Authentication

Connect your local tools to the platform:
erdo login
This will:
  • Open your browser for authentication
  • Store your credentials securely
  • Set up API access for both CLI and SDK

​
Verify Authentication

erdo whoami

​
System Requirements

Minimum Requirements

  • OS: macOS 10.15+, Linux, Windows 10+ - Memory: 2GB RAM - Python: 3.8+ (for SDK) - Node.js: 16+ (for development)

Recommended

  • OS: Latest macOS, Ubuntu 20.04+, Windows 11 - Memory: 8GB+ RAM - Python: 3.11+ - Storage: 10GB+ available space

​
Development Environment

​
IDE Setup

Install the Erdo extension for enhanced development experience:
code --install-extension erdoai.erdo-vscode
Features:
  • Syntax highlighting for Erdo agent files
  • IntelliSense and autocomplete
  • Built-in debugging tools
  • Agent preview and testing

​
Git Configuration

For collaborative development: 
# Clone agent repositories
git clone https://github.com/your-org/your-agents.git

# Set up .gitignore for Erdo projects
echo ".erdo/cache/" >> .gitignore
echo "*.log" >> .gitignore
echo ".env.local" >> .gitignore

​
Configuration

​
Environment Variables

Set up common environment variables: 
# ~/.bashrc or ~/.zshrc
export ERDO_API_URL="https://api.erdo.ai"
export ERDO_LOG_LEVEL="info"
export ERDO_CACHE_DIR="~/.erdo/cache"

​
Configuration File

Create a global configuration file at ~/.erdo/config.yaml: 
# Erdo Configuration
api:
  url: "https://api.erdo.ai"
  timeout: 30

logging:
  level: "info"
  format: "structured"

cache:
  enabled: true
  ttl: 3600

development:
  auto_save: true
  watch_mode: true

​
Troubleshooting

Permission denied errors:
sudo chmod +x erdo
sudo chown $(whoami) erdo
PATH issues:
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
Virtual environment issues:
python -m venv erdo-env
source erdo-env/bin/activate  # On Windows: erdo-env\Scripts\activate
pip install erdo
Dependency conflicts:
pip install --upgrade erdo
pip install --force-reinstall erdo
Login failures:
erdo logout
erdo login --force
Token issues:
rm ~/.erdo/auth.json
erdo login
Slow operations:
  • Clear cache: erdo cache clear
  • Update CLI: brew upgrade erdo
  • Check internet connection
  • Verify system resources

​
Next Steps

Now that you have Erdo installed:
  1. Follow the Quick Start - Build your first agent
  2. Explore Examples - See real-world use cases
  3. Read the SDK Docs - Dive deeper into development