Getting Started

Seedfast powered by AI makes it effortless to populate your database with meaningful and structured data. This guide will walk you through installing the CLI, connecting your database, and running your first seed.

Before you begin

Make sure you have PostgreSQL installed and accessible from your environment.

Install the Seedfast CLI

Install Seedfast using Homebrew:

brew install argon-it/tap/seedfast

or via Node Package Manager (npm):

npm install seedfast

This command will add the Seedfast CLI to your system and make it globally available in your terminal.

To execute the commands below, you can use seedfast CLI directly (if installed via Homebrew) or access it via npx if the package was installed via npm.

To verify installation, run:

seedfast --version

Authenticate your account

Run the login command and follow the CLI instructions to authenticate:

seedfast login

This step connects your local CLI to your Seedfast account.

Connect your database

Next, connect the database you want to seed. Seedfast will automatically detect your schema and prepare it for seeding.

seedfast connect

You'll be prompted to provide your connection string (for example, to a local PostgreSQL instance). Seedfast reads your schema structure and prepares it for intelligent data generation.

Run your first seed

After analyzing your schema, the CLI automatically determines what to seed and generates structured data using AI. Depending on database size, this process usually completes in under two minutes.

Once connected, start the seeding process:

seedfast seed