Swarms Installation Guide¶

You can install swarms with pip in a Python>=3.10 environment.

Prerequisites¶

Before you begin, ensure you have the following installed:

Python 3.10 or higher: Download Python
pip (specific version recommended): pip >= 21.0
git (for cloning the repository): Download Git

Installation Options¶

pip (Recommended)Development InstallationUsing DockerUsing KubernetesCI/CD Pipelines

Headless Installation¶

The headless installation of swarms is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.

pip install swarms

Using virtualenvUsing AnacondaUsing Poetry

Clone the repository and navigate to the root directory:

git clone https://github.com/kyegomez/swarms.git
cd swarms

Setup Python environment and activate it:

python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip

Install Swarms:

Headless install:
```
pip install -e .
```
Desktop install:
```
pip install -e .[desktop]
```

Create and activate an Anaconda environment:

conda create -n swarms python=3.10
conda activate swarms

Clone the repository and navigate to the root directory:

git clone https://github.com/kyegomez/swarms.git
cd swarms

Install Swarms:

Headless install:
```
pip install -e .
```
Desktop install:
```
pip install -e .[desktop]
```

Clone the repository and navigate to the root directory:

git clone https://github.com/kyegomez/swarms.git
cd swarms

Setup Python environment and activate it:
```
poetry env use python3.10
poetry shell
```

Install Swarms:

Headless install:
```
poetry install
```
Desktop install:
```
poetry install --extras "desktop"
```

Docker is an excellent option for creating isolated and reproducible environments, suitable for both development and production. Contact us if there are any issues with the docker setup

Pull the Docker image:
```
docker pull swarmscorp/swarms:tagname
```

Run the Docker container:

docker run -it --rm swarmscorp/swarms:tagname

Build and run a custom Docker image:

# Use Python 3.11 instead of 3.13
FROM python:3.11-slim

# Set environment variables
ENV PYTHONDONTWRITEBYTECODE=1 \
    PYTHONUNBUFFERED=1 \
    WORKSPACE_DIR="agent_workspace" \
    OPENAI_API_KEY="your_swarm_api_key_here"

# Set the working directory
WORKDIR /usr/src/swarms

# Install system dependencies
RUN apt-get update && apt-get install -y \
    build-essential \
    gcc \
    g++ \
    gfortran \
    && rm -rf /var/lib/apt/lists/*

# Install swarms package
RUN pip3 install -U swarm-models
RUN pip3 install -U swarms

# Copy the application
COPY . .

Kubernetes provides an automated way to deploy, scale, and manage containerized applications.

Create a Deployment YAML file:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: swarms-deployment
spec:
  replicas: 3
  selector:
    matchLabels:
      app: swarms
  template:
    metadata:
      labels:
        app: swarms
    spec:
      containers:
      - name: swarms
        image: kyegomez/swarms
        ports:
        - containerPort: 8080

Apply the Deployment:
```
kubectl apply -f deployment.yaml
```

Expose the Deployment:

kubectl expose deployment swarms-deployment --type=LoadBalancer --name=swarms-service

Integrating Swarms into your CI/CD pipeline ensures automated testing and deployment.

Using GitHub Actions¶

# .github/workflows/ci.yml
name: CI

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: 3.10
    - name: Install dependencies
      run: |
        python -m venv venv
        source venv/bin/activate
        pip install --upgrade pip
        pip install -e .
    - name: Run tests
      run: |
        source venv/bin/activate
        pytest

Using Jenkins¶

pipeline {
    agent any

    stages {
        stage('Clone repository') {
            steps {
                git 'https://github.com/kyegomez/swarms.git'
            }
        }
        stage('Setup Python') {
            steps {
                sh 'python3 -m venv venv'
                sh 'source venv/bin/activate && pip install --upgrade pip'
            }
        }
        stage('Install dependencies') {
            steps {
                sh 'source venv/bin/activate && pip install -e .'
            }
        }
        stage('Run tests') {
            steps {
                sh 'source venv/bin/activate && pytest'
            }
        }
    }
}

Javascript¶

NPM install (Work in Progress)

Get started with the NPM implementation of Swarms:

npm install swarms-js