Skip to content

AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.

dx(platform): Add initial setup scripts for linux and windows (#9912)

Bently22d58367ec18
diff --git a/autogpt_platform/frontend/package.json b/autogpt_platform/frontend/package.json
index 81ddbb969e..c51fa60c41 100644
--- a/autogpt_platform/frontend/package.json
+++ b/autogpt_platform/frontend/package.json
@@ -4,7 +4,7 @@
"private": true,
"scripts": {
"dev": "next dev --turbo",
- "build": "pnpm run generate:api-client && SKIP_STORYBOOK_TESTS=true next build",
+ "build": "cross-env pnpm run generate:api-client && SKIP_STORYBOOK_TESTS=true next build",
"start": "next start",
"start:standalone": "cd .next/standalone && node server.js",
"lint": "next lint && prettier --check .",
@@ -113,6 +113,7 @@
"axe-playwright": "2.1.0",
"chromatic": "11.25.2",
"concurrently": "9.2.0",
+ "cross-env": "7.0.3",
"eslint": "8.57.1",
"eslint-config-next": "15.3.4",
"eslint-plugin-storybook": "9.0.14",
diff --git a/autogpt_platform/frontend/pnpm-lock.yaml b/autogpt_platform/frontend/pnpm-lock.yaml
index 0b8867ef7f..64b4f0a29c 100644
--- a/autogpt_platform/frontend/pnpm-lock.yaml
+++ b/autogpt_platform/frontend/pnpm-lock.yaml
@@ -264,6 +264,9 @@ importers:
concurrently:
specifier: 9.2.0
version: 9.2.0
+ cross-env:
+ specifier: 7.0.3
+ version: 7.0.3
eslint:
specifier: 8.57.1
version: 8.57.1
@@ -3809,6 +3812,16 @@ packages:
resolution: {integrity: sha512-MJG9liiZ+ogc4TzUwuvbER1JRdgvUFSB5+VR/g5h82fGaIRWMWddtKBHi7/sVhfjQZ6SehlyhvQYrcYkaUIpLg==}
+ resolution: {integrity: sha512-Adz2bdH0Vq3F53KEMJOoftQFutWCukm6J24wbPWRO4k1kMY7gS7ds/uoJkNuV8wDCtWWnuwGcJwpWcih+zEW1Q==}
+ engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0}
+ hasBin: true
+
+ resolution: {integrity: sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==}
+ engines: {node: '>=10.14', npm: '>=6', yarn: '>=1'}
+ hasBin: true
+
resolution: {integrity: sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==}
engines: {node: '>= 8'}
@@ -11182,6 +11195,25 @@ snapshots:
safe-buffer: 5.2.1
sha.js: 2.4.11
+ dependencies:
+ '@jest/types': 29.6.3
+ chalk: 4.1.2
+ exit: 0.1.2
+ graceful-fs: 4.2.11
+ jest-config: 29.7.0(@types/[email protected])
+ jest-util: 29.7.0
+ prompts: 2.4.2
+ transitivePeerDependencies:
+ - '@types/node'
+ - babel-plugin-macros
+ - supports-color
+ - ts-node
+
+ dependencies:
+ cross-spawn: 7.0.6
+
dependencies:
path-key: 3.1.1
diff --git a/autogpt_platform/installer/setup-autogpt.bat b/autogpt_platform/installer/setup-autogpt.bat
new file mode 100644
index 0000000000..f78a50de71
--- /dev/null
+++ b/autogpt_platform/installer/setup-autogpt.bat
@@ -0,0 +1,132 @@
+@echo off
+setlocal enabledelayedexpansion
+
+goto :main
+
+REM --- Helper: Check command existence ---
+:check_command
+if "%1"=="" (
+ echo ERROR: check_command called with no command argument!
+ pause
+ exit /b 1
+)
+where %1 >nul 2>nul
+if errorlevel 1 (
+ echo %2 is not installed. Please install it and try again.
+ pause
+ exit /b 1
+) else (
+ echo %2 is installed.
+)
+goto :eof
+
+:main
+echo =============================
+echo AutoGPT Windows Setup
+echo =============================
+echo.
+
+REM --- Variables ---
+set SCRIPT_DIR=%~dp0
+set LOG_DIR=%SCRIPT_DIR%logs
+set BACKEND_LOG=%LOG_DIR%\backend_setup.log
+set FRONTEND_LOG=%LOG_DIR%\frontend_setup.log
+set CLONE_NEEDED=0
+set REPO_DIR=%SCRIPT_DIR%..\..
+
+REM --- Create logs folder immediately ---
+if not exist "%LOG_DIR%" mkdir "%LOG_DIR%"
+
+echo Checking prerequisites...
+call :check_command git Git
+call :check_command docker Docker
+call :check_command npm Node.js
+call :check_command pnpm pnpm
+echo.
+
+REM --- Detect repo ---
+if exist "%REPO_DIR%\.git" (
+ set CLONE_NEEDED=0
+) else (
+ set REPO_DIR=%SCRIPT_DIR%AutoGPT
+ set CLONE_NEEDED=1
+)
+
+REM --- Clone repo if needed ---
+if %CLONE_NEEDED%==1 (
+ echo Cloning AutoGPT repository...
+ git clone https://github.com/Significant-Gravitas/AutoGPT.git "%REPO_DIR%"
+ if errorlevel 1 (
+ echo Failed to clone repository.
+ pause
+ exit /b 1
+ )
+) else (
+ echo Using existing AutoGPT repository.
+)
+echo.
+
+REM --- Prompt for Sentry enablement ---
+set SENTRY_ENABLED=0
+echo Would you like to enable debug information to be shared so we can fix your issues? [Y/n]
+set /p sentry_answer="Enable Sentry? [Y/n]: "
+if /I "%sentry_answer%"=="" set SENTRY_ENABLED=1
+if /I "%sentry_answer%"=="y" set SENTRY_ENABLED=1
+if /I "%sentry_answer%"=="yes" set SENTRY_ENABLED=1
+if /I "%sentry_answer%"=="n" set SENTRY_ENABLED=0
+if /I "%sentry_answer%"=="no" set SENTRY_ENABLED=0
+
+REM --- Setup backend ---
+echo Setting up backend services...
+echo.
+cd /d "%REPO_DIR%\autogpt_platform"
+if exist .env.example copy /Y .env.example .env >nul
+cd backend
+if exist .env.example copy /Y .env.example .env >nul
+
+REM --- Set SENTRY_DSN in backend/.env ---
+set SENTRY_DSN=https://11d0640fef35640e0eb9f022eb7d7626@o4505260022104064.ingest.us.sentry.io/4507890252447744
+if %SENTRY_ENABLED%==1 (
+ powershell -Command "(Get-Content .env) -replace '^SENTRY_DSN=.*', 'SENTRY_DSN=%SENTRY_DSN%' | Set-Content .env"
+ echo Sentry enabled in backend.
+) else (
+ powershell -Command "(Get-Content .env) -replace '^SENTRY_DSN=.*', 'SENTRY_DSN=' | Set-Content .env"
+ echo Sentry not enabled in backend.
+)
+cd ..
+
+docker compose down > "%BACKEND_LOG%" 2>&1
+if errorlevel 1 echo (docker compose down failed, continuing...)
+docker compose up -d --build >> "%BACKEND_LOG%" 2>&1
+if errorlevel 1 (
+ echo Backend setup failed. See log: %BACKEND_LOG%
+ pause
+ exit /b 1
+)
+echo Backend services started successfully.
+echo.
+
+REM --- Setup frontend ---
+echo Setting up frontend application...
+echo.
+cd frontend
+if exist .env.example copy /Y .env.example .env >nul
+call pnpm.cmd install
+if errorlevel 1 (
+ echo pnpm install failed!
+ pause
+ exit /b 1
+)
+echo Frontend dependencies installed successfully.
+echo.
+
+REM --- Start frontend dev server in the same terminal ---
+echo Setup complete!
+echo Access AutoGPT at: http://localhost:3000
+echo To stop services, press Ctrl+C and run "docker compose down" in %REPO_DIR%\autogpt_platform
+echo.
+echo The frontend will now start in this terminal. Closing this window will stop the frontend.
+echo Press Ctrl+C to stop the frontend at any time.
+echo.
+
+call pnpm.cmd dev
\ No newline at end of file
diff --git a/autogpt_platform/installer/setup-autogpt.sh b/autogpt_platform/installer/setup-autogpt.sh
new file mode 100644
index 0000000000..4afdbce51a
--- /dev/null
+++ b/autogpt_platform/installer/setup-autogpt.sh
@@ -0,0 +1,339 @@
+#!/bin/bash
+
+# ------------------------------------------------------------------------------
+# AutoGPT Setup Script
+# ------------------------------------------------------------------------------
+# This script automates the installation and setup of AutoGPT on Linux systems.
+# It checks prerequisites, clones the repository, sets up backend and frontend,
+# configures Sentry (optional), and starts all services. Designed for clarity
+# and maintainability. Run this script from a terminal.
+# ------------------------------------------------------------------------------
+
+# --- Global Variables ---
+GREEN='\033[0;32m'
+BLUE='\033[0;34m'
+YELLOW='\033[1;33m'
+RED='\033[0;31m'
+NC='\033[0m' # No Color
+REPO_DIR=""
+CLONE_NEEDED=false
+DOCKER_CMD="docker"
+DOCKER_COMPOSE_CMD="docker compose"
+LOG_DIR=""
+SENTRY_ENABLED=0
+
+# ------------------------------------------------------------------------------
+# Helper Functions
+# ------------------------------------------------------------------------------
+
+# Print colored text
+print_color() {
+ printf "${!1}%s${NC}\n" "$2"
+}
+
+# Print the ASCII banner
+print_banner() {
+ print_color "BLUE" "
+ d8888 888 .d8888b. 8888888b. 88888888888
+ d88888 888 d88P Y88b 888 Y88b 888
+ d88P888 888 888 888 888 888 888
+ d88P 888 888 888 888888 .d88b. 888 888 d88P 888
+ d88P 888 888 888 888 d88\"\"88b 888 88888 8888888P\" 888
+ d88P 888 888 888 888 888 888 888 888 888 888
+ d8888888888 Y88b 888 Y88b. Y88..88P Y88b d88P 888 888
+d88P 888 \"Y88888 \"Y888 \"Y88P\" \"Y8888P88 888 888
+"
+}
+
+# Handle errors and exit
+handle_error() {
+ echo ""
+ print_color "RED" "Error: $1"
+ print_color "YELLOW" "Press Enter to exit..."
+ read -r
+ exit 1
+}
+
+# ------------------------------------------------------------------------------
+# Logging Functions
+# ------------------------------------------------------------------------------
+
+# Prepare log directory
+setup_logs() {
+ LOG_DIR="$REPO_DIR/autogpt_platform/logs"
+ mkdir -p "$LOG_DIR"
+}
+
+# ------------------------------------------------------------------------------
+# Health Check Functions
+# ------------------------------------------------------------------------------
+
+# Check service health by polling an endpoint
+check_health() {
+ local url=$1
+ local expected=$2
+ local name=$3
+ local max_attempts=$4
+ local timeout=$5
+
+ if ! command -v curl &> /dev/null; then
+ echo "curl not found. Skipping health check for $name."
+ return 0
+ fi
+
+ echo "Checking $name health..."
+ for ((attempt=1; attempt<=max_attempts; attempt++)); do
+ echo "Attempt $attempt/$max_attempts"
+ response=$(curl -s --max-time "$timeout" "$url")
+ if [[ "$response" == *"$expected"* ]]; then
+ echo "✓ $name is healthy"
+ return 0
+ fi
+ echo "Waiting 5s before next attempt..."
+ sleep 5
+ done
+ echo "✗ $name health check failed after $max_attempts attempts"
+ return 1
+}
+
+# ------------------------------------------------------------------------------
+# Prerequisite and Environment Functions
+# ------------------------------------------------------------------------------
+
+# Check for required commands
+check_command() {
+ local cmd=$1
+ local name=$2
+ local url=$3
+
+ if ! command -v "$cmd" &> /dev/null; then
+ handle_error "$name is not installed. Please install it and try again. Visit $url"
+ else
+ print_color "GREEN" "✓ $name is installed"
+ fi
+}
+
+# Check for optional commands
+check_command_optional() {
+ local cmd=$1
+ if command -v "$cmd" &> /dev/null; then
+ print_color "GREEN" "✓ $cmd is installed"
+ else
+ print_color "YELLOW" "$cmd is not installed. Some features will be skipped."
+ fi
+}
+
+# Check Docker permissions and adjust commands if needed
+check_docker_permissions() {
+ if ! docker info &> /dev/null; then
+ print_color "YELLOW" "Docker requires elevated privileges. Using sudo for Docker commands..."
+ DOCKER_CMD="sudo docker"
+ DOCKER_COMPOSE_CMD="sudo docker compose"
+ fi
+}
+
+# Check all prerequisites
+check_prerequisites() {
+ print_color "GREEN" "AutoGPT's Automated Setup Script"
+ print_color "GREEN" "-------------------------------"
+ print_color "BLUE" "This script will automatically install and set up AutoGPT for you."
+ echo ""
+ print_color "YELLOW" "Checking prerequisites:"
+
+ check_command git "Git" "https://git-scm.com/downloads"
+ check_command docker "Docker" "https://docs.docker.com/get-docker/"
+ check_docker_permissions
+ check_command npm "npm (Node.js)" "https://nodejs.org/en/download/"
+ check_command pnpm "pnpm (Node.js package manager)" "https://pnpm.io/installation"
+ check_command_optional curl "curl"
+
+ print_color "GREEN" "All prerequisites are installed! Starting installation..."
+ echo ""
+}
+
+# Detect installation mode and set repo directory
+# (Clones if not in a repo, otherwise uses current directory)
+detect_installation_mode() {
+ if [[ "$PWD" == */autogpt_platform/installer ]]; then
+ if [[ -d "../../.git" ]]; then
+ REPO_DIR="$(cd ../..; pwd)"
+ CLONE_NEEDED=false
+ cd ../.. || handle_error "Failed to navigate to repository root."
+ else
+ CLONE_NEEDED=true
+ REPO_DIR="$(pwd)/AutoGPT"
+ cd "$(dirname \"$(dirname \"$(dirname \"$PWD\")\")\")" || handle_error "Failed to navigate to parent directory."
+ fi
+ elif [[ -d ".git" && -d "autogpt_platform/installer" ]]; then
+ REPO_DIR="$PWD"
+ CLONE_NEEDED=false
+ else
+ CLONE_NEEDED=true
+ REPO_DIR="$(pwd)/AutoGPT"
+ fi
+}
+
+# Clone the repository if needed
+clone_repository() {
+ if [ "$CLONE_NEEDED" = true ]; then
+ print_color "BLUE" "Cloning AutoGPT repository..."
+ if git clone https://github.com/Significant-Gravitas/AutoGPT.git "$REPO_DIR"; then
+ print_color "GREEN" "✓ Repo cloned successfully!"
+ else
+ handle_error "Failed to clone the repository."
+ fi
+ else
+ print_color "GREEN" "Using existing AutoGPT repository"
+ fi
+}
+
+# Prompt for Sentry enablement and set global flag
+prompt_sentry_enablement() {
+ print_color "YELLOW" "Would you like to enable debug information to be shared so we can fix your issues? [Y/n]"
+ read -r sentry_answer
+ case "${sentry_answer,,}" in
+ ""|y|yes)
+ SENTRY_ENABLED=1
+ ;;
+ n|no)
+ SENTRY_ENABLED=0
+ ;;
+ *)
+ print_color "YELLOW" "Invalid input. Defaulting to yes. Sentry will be enabled."
+ SENTRY_ENABLED=1
+ ;;
+ esac
+}
+
+# ------------------------------------------------------------------------------
+# Setup Functions
+# ------------------------------------------------------------------------------
+
+# Set up backend services and configure Sentry if enabled
+setup_backend() {
+ print_color "BLUE" "Setting up backend services..."
+ cd "$REPO_DIR/autogpt_platform" || handle_error "Failed to navigate to backend directory."
+ cp .env.example .env || handle_error "Failed to copy environment file."
+
+ # Set SENTRY_DSN in backend/.env
+ cd backend || handle_error "Failed to navigate to backend subdirectory."
+ cp .env.example .env || handle_error "Failed to copy backend environment file."
+ sentry_url="https://11d0640fef35640e0eb9f022eb7d7626@o4505260022104064.ingest.us.sentry.io/4507890252447744"
+ if [ "$SENTRY_ENABLED" = "1" ]; then
+ sed -i "s|^SENTRY_DSN=.*$|SENTRY_DSN=$sentry_url|" .env || echo "SENTRY_DSN=$sentry_url" >> .env
+ print_color "GREEN" "Sentry enabled in backend."
+ else
+ sed -i "s|^SENTRY_DSN=.*$|SENTRY_DSN=|" .env || echo "SENTRY_DSN=" >> .env
+ print_color "YELLOW" "Sentry not enabled in backend."
+ fi
+ cd .. # back to autogpt_platform
+
+ $DOCKER_COMPOSE_CMD down || handle_error "Failed to stop existing backend services."
+ $DOCKER_COMPOSE_CMD up -d --build || handle_error "Failed to start backend services."
+ print_color "GREEN" "✓ Backend services started successfully"
+}
+
+# Set up frontend application
+setup_frontend() {
+ print_color "BLUE" "Setting up frontend application..."
+ cd "$REPO_DIR/autogpt_platform/frontend" || handle_error "Failed to navigate to frontend directory."
+ cp .env.example .env || handle_error "Failed to copy frontend environment file."
+ corepack enable || handle_error "Failed to enable corepack."
+ pnpm install || handle_error "Failed to install frontend dependencies."
+ print_color "GREEN" "✓ Frontend dependencies installed successfully"
+}
+
+# Run backend and frontend setup concurrently and manage logs
+run_concurrent_setup() {
+ setup_logs
+ backend_log="$LOG_DIR/backend_setup.log"
+ frontend_log="$LOG_DIR/frontend_setup.log"
+
+ : > "$backend_log"
+ : > "$frontend_log"
+
+ setup_backend > "$backend_log" 2>&1 &
+ backend_pid=$!
+ echo "Backend setup finished."
+
+ setup_frontend > "$frontend_log" 2>&1 &
+ frontend_pid=$!
+ echo "Frontend setup finished."
+
+ show_spinner "$backend_pid" "$frontend_pid"
+
+ wait $backend_pid; backend_status=$?
+ wait $frontend_pid; frontend_status=$?
+
+ if [ $backend_status -ne 0 ]; then
+ print_color "RED" "Backend setup failed. See log: $backend_log"
+ exit 1
+ fi
+
+ if [ $frontend_status -ne 0 ]; then
+ print_color "RED" "Frontend setup failed. See log: $frontend_log"
+ exit 1
+ fi
+
+}
+
+# Show a spinner while background jobs run
+show_spinner() {
+ local backend_pid=$1
+ local frontend_pid=$2
+ spin='-\|/'
+ i=0
+ messages=("Working..." "Still working..." "Setting up dependencies..." "Almost there...")
+ msg_index=0
+ msg_counter=0
+ clear_line=" "
+
+ while kill -0 $backend_pid 2>/dev/null || kill -0 $frontend_pid 2>/dev/null; do
+ i=$(( (i+1) % 4 ))
+ msg_counter=$(( (msg_counter+1) % 300 ))
+ if [ $msg_counter -eq 0 ]; then
+ msg_index=$(( (msg_index+1) % ${#messages[@]} ))
+ fi
+ printf "\r${clear_line}\r${YELLOW}[%c]${NC} %s" "${spin:$i:1}" "${messages[$msg_index]}"
+ sleep .1
+ done
+ printf "\r${clear_line}\r${GREEN}[✓]${NC} Setup completed!\n"
+}
+
+# ------------------------------------------------------------------------------
+# Main Entry Point
+# ------------------------------------------------------------------------------
+
+main() {
+ print_banner
+ check_prerequisites
+ prompt_sentry_enablement
+ detect_installation_mode
+ clone_repository
+ setup_logs
+ run_concurrent_setup
+
+ print_color "YELLOW" "Starting frontend..."
+ (cd "$REPO_DIR/autogpt_platform/frontend" && pnpm dev > "$LOG_DIR/frontend_dev.log" 2>&1 &)
+
+ print_color "YELLOW" "Waiting for services to start..."
+ sleep 20
+
+ print_color "YELLOW" "Verifying services health..."
+ check_health "http://localhost:8006/health" "\"status\":\"healthy\"" "Backend" 6 15
+ check_health "http://localhost:3000/health" "Yay im healthy" "Frontend" 6 15
+
+ if [ $backend_status -ne 0 ] || [ $frontend_status -ne 0 ]; then
+ print_color "RED" "Setup failed. See logs for details."
+ exit 1
+ fi
+
+ print_color "GREEN" "Setup complete!"
+ print_color "BLUE" "Access AutoGPT at: http://localhost:3000"
+ print_color "YELLOW" "To stop services, press Ctrl+C and run 'docker compose down' in $REPO_DIR/autogpt_platform"
+ echo ""
+ print_color "GREEN" "Press Enter to exit (services will keep running)..."
+ read -r
+}
+
+main
diff --git a/docs/content/platform/installer.md b/docs/content/platform/installer.md
new file mode 100644
index 0000000000..3faf6a8239
--- /dev/null
+++ b/docs/content/platform/installer.md
@@ -0,0 +1,70 @@
+# AutoGPT Platform Installer
+
+The AutoGPT Platform provides easy-to-use installers to help you quickly set up the platform on your system. This page covers how to use the installer scripts for both Linux/macOS and Windows.
+
+## What the Installer Does
+
+The installer scripts will:
+
+1. Check for required prerequisites (Git, Docker, npm)
+2. Clone the AutoGPT repository
+3. Set up the backend services using Docker
+4. Set up the frontend application
+5. Start both the backend and frontend services
+
+## Prerequisites
+
+Before running the installer, make sure you have the following installed:
+
+- **Git**: For cloning the repository
+- **Docker**: For running the backend services
+- **Node.js and npm**: For the frontend application
+
+## Quick One-Liner Installation
+
+For convenience, you can use the following one-liner commands to install AutoGPT Platform:
+
+### Linux/macOS
+
+```bash
+curl -fsSL https://setup.agpt.co/install.sh -o install.sh && bash install.sh
+```
+
+### Windows
+
+```powershell
+powershell -c "iwr https://setup.agpt.co/install.bat -o install.bat; ./install.bat"
+```
+
+## Manual Installation
+
+If you prefer, you can manually download and run the installer scripts:
+
+- **Linux/macOS:** `setup-autogpt.sh`
+- **Windows:** `setup-autogpt.bat`
+
+Follow the instructions in the [installer README](../../../../autogpt_platform/installer/README.md) for more details.
+
+## After Installation
+
+Once the installation is complete:
+- The backend services will be running in Docker containers
+- The frontend application will be available at http://localhost:3000
+
+## Stopping the Services
+
+To stop the services, press Ctrl+C in the terminal where the frontend is running, then run:
+
+```bash
+cd AutoGPT/autogpt_platform
+docker compose down
+```
+
+## Troubleshooting
+
+If you encounter any issues during installation:
+
+1. Make sure all prerequisites are correctly installed
+2. Check that Docker is running
+3. Ensure you have a stable internet connection
+4. Verify you have sufficient permissions to create directories and run Docker
\ No newline at end of file