Seedfast

Seedfast

Authentication

Seedfast uses two authentication methods depending on how you run it: browser-based login for interactive local use, and API keys for CI/CD pipelines and scripted environments.

Browser login (interactive)#

For local development, authenticate once with your Seedfast account:

macOS / Linux:

seedfast login

Windows:

npx seedfast login

A browser window opens and walks you through the login flow. Once complete, credentials are stored locally and reused on every subsequent run — you won't need to log in again on the same machine unless you explicitly log out.

If you don't have an account yet, sign up at seedfa.st — a free trial is available, no credit card required.

To log out:

macOS / Linux:

seedfast logout

Windows:

npx seedfast logout

API keys (non-interactive)#

In CI/CD pipelines and other non-interactive environments, browser-based login isn't available. Use an API key instead.

Generate an API key:

  1. Log in to the Seedfast Dashboard
  2. Go to Settings → API Keys
  3. Click Create New Key and give it a name (e.g. "GitHub Actions")
  4. Copy the key immediately — it won't be shown again

Your key format: sfk_live_...

Use the key in your environment:

macOS / Linux:

export SEEDFAST_API_KEY=sfk_live_your_key_here
seedfast seed --scope "..."

Windows (PowerShell):

$env:SEEDFAST_API_KEY="sfk_live_your_key_here"
npx seedfast seed --scope "..."

Or pass it inline:

macOS / Linux:

SEEDFAST_API_KEY=sfk_live_your_key_here seedfast seed --scope "..."

Windows (PowerShell):

$env:SEEDFAST_API_KEY="sfk_live_your_key_here"; npx seedfast seed --scope "..."

In CI/CD platforms, store the key as an encrypted secret and reference it in your pipeline config. See the CI/CD guide for platform-specific examples.

Best practice: Create separate API keys per environment (local, staging, CI). This makes it easy to revoke or rotate individual keys without affecting other environments.

Verify authentication#

Check that the CLI is authenticated and ready:

macOS / Linux:

seedfast whoami

Windows:

npx seedfast whoami

This prints your account email and confirms the CLI is connected to your account.