Installation

This guide will walk you through the process of installing Seed-Farmer and its dependencies.

Prerequisites¶

Before installing Seed-Farmer, ensure you have the following prerequisites:

Python >=3.10 - Seed-Farmer runs in Python (3.10, 3.11, 3.12, and 3.13 are supported)
AWS CLI - For configuring credentials on compute
AWS CDK and CDK Bootstrap (recommended) - the majority of Seed-Farmer Public Modules use AWS CDkv2
Python Management Tool - uv or pip

Installing Seed-Farmer¶

Seed-Farmer supports uv and pip for installation for use.

It is recommended to install uv as the primary installation tool.

curl -LsSf https://astral.sh/uv/install.sh | sh

Using uv¶

Install Seed-Farmer as a tool.

## you can use any supported Python version (3.10, 3.11, 3.12, or 3.13)

uv tool install --python 3.12 seed-farmer

You can pin to a particular version by referring to the version in the install ( see the pypi release history )

Using pip¶

Install Seed-Farmer using pip

python -m venv .venv
source .venv/bin/activate
pip install seed-farmer

From Source¶

You can also install Seed-Farmer from source using your installation of choice:

git clone https://github.com/awslabs/seed-farmer.git
cd seed-farmer

## Via Source Code with uv 
uv pip install -e .

## -- OR -- 

## Via Source Code with pip 
pip install -e .

Verifying the Installation¶

To verify that Seed-Farmer is installed correctly, run:

seedfarmer --version

seedfarmer, version 7.0.12

This should display the version of Seed-Farmer that you have installed.

Setting Up Your Environment¶

AWS CLI and Credentials¶

Install the AWS CLI and configure your preferred method of AWS Credentials.

AWS CDK¶

Run the AWS CDK Bootstrap in each target account using the AWS CDK.

Next Steps¶

Now that you have Seed-Farmer installed, you can:

Learn how to Bootstrap your AWS accounts for Seed-Farmer
Follow the Quick Start guide to deploy your first project
Explore the Concepts behind Seed-Farmer