Skip to content

Quick Start

Get from zero to using Soup in under 5 minutes.

Create your free account at app.getsoup.dev

Terminal window
curl -fsSL https://cli.getsoup.dev/install.sh | sh

The installer downloads the correct binary for your platform (Linux/macOS x64/ARM).

Terminal window
# Opens browser for GitHub login
soup login
# Or use device flow for remote/headless machines
soup login --device

Via dashboard or CLI:

Terminal window
soup project create my-app
soup env create my-app root
soup env create my-app development --parent root
soup env create my-app production --parent root

Environments inherit from their parent. Name them whatever you want.

Terminal window
# Set in root (inherited by child environments)
soup secrets set DATABASE_URL postgres://localhost/myapp
soup secrets set LOG_LEVEL debug
# Override in production
soup secrets set --env production LOG_LEVEL warn
soup secrets set --env production DATABASE_URL postgres://prod-db/myapp
Terminal window
# Inject as env vars and run your app
soup run -- npm start
# Export to shell
eval $(soup secrets export)
# Download as .env file
soup secrets download > .env
Terminal window
soup flags create dark-mode
soup flags on dark-mode

Then evaluate via API:

Terminal window
curl https://app.getsoup.dev/api/v1/projects/my-app/environments/production/flags/dark-mode/evaluate \
-H "Authorization: Bearer $SOUP_TOKEN" \
-d '{"context": {"user_id": "123"}}'