Before you begin, ensure you have the following installed:
- Python 3.10 or higher: [Download Python](https://www.python.org/)
- pip (specific version recommended): `pip >= 21.0`
- git (for cloning the repository): [Download Git](https://git-scm.com/)
## Installation Options
=== "pip (Recommended)"
#### Headless Installation
=== "headless"
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.
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.
```bash
```bash
pip install swarms
pip install swarms
```
```
=== "Development Installation"
=== "Using virtualenv"
!!! example "git clone (for development)"
1. **Clone the repository and navigate to the root directory:**
=== "virtualenv"
```bash
```bash
# clone repository and navigate to root directory
git clone https://github.com/kyegomez/swarms.git
git clone https://github.com/kyegomez/swarms.git
cd swarms
cd swarms
```
2. **Setup Python environment and activate it:**
# setup python environment and activate it
```bash
python3 -m venv venv
python3 -m venv venv
source venv/bin/activate
source venv/bin/activate
pip install --upgrade pip
pip install --upgrade pip
```
3. **Install Swarms:**
# headless install
- Headless install:
pip install -e "."
# desktop install
```bash
pip install -e ".[desktop]"
pip install -e .
```
```
=== "poetry"
- Desktop install:
```bash
pip install -e .[desktop]
```
=== "Using Anaconda"
1. **Create and activate an Anaconda environment:**
```bash
conda create -n swarms python=3.10
conda activate swarms
```
2. **Clone the repository and navigate to the root directory:**
```bash
```bash
# clone repository and navigate to root directory
git clone https://github.com/kyegomez/swarms.git
git clone https://github.com/kyegomez/swarms.git
cd swarms
cd swarms
```
3. **Install Swarms:**
- Headless install:
# setup python environment and activate it
```bash
pip install -e .
```
- Desktop install:
```bash
pip install -e .[desktop]
```
=== "Using Poetry"
1. **Clone the repository and navigate to the root directory:**
```bash
git clone https://github.com/kyegomez/swarms.git
cd swarms
```
2. **Setup Python environment and activate it:**
```bash
poetry env use python3.10
poetry env use python3.10
poetry shell
poetry shell
```
# headless install
3. **Install Swarms:**
- Headless install:
```bash
poetry install
poetry install
```
- Desktop install:
# desktop install
```bash
poetry install --extras "desktop"
poetry install --extras "desktop"
```
```
## Javascript
# Javascript
=== "NPM install (Work in Progress)"
!!! example "NPM install |WIP|"
Get started with the NPM implementation of Swarms:
=== "headless"
Get started with the NPM implementation of Swarms with this command: