Hogsend
CLI Reference

hogsend setup

Interactive local onboarding for a scaffolded Hogsend app — bring up infra, create .env, generate a secret, and run migrations.

Interactive local onboarding for a scaffolded Hogsend app — a standalone CLI helper that brings up the core local stack for you:

  1. docker compose up -d — Postgres, Redis, and Hatchet-Lite
  2. cp .env.example .env (if .env is missing)
  3. Generate a BETTER_AUTH_SECRET (if it's still the placeholder)
  4. pnpm db:migrate — the engine track, then your client track

Scaffolded apps ship a pnpm bootstrap script that does all of this plus minting the local Hatchet token, minting an ingest-scoped HOGSEND_API_KEY, auto-remapping any conflicting host ports, and an interactive, skippable "create your first Studio admin" prompt after migrations — that's the recommended local setup (Installation). pnpm bootstrap is idempotent and safe to re-run. hogsend setup is the standalone CLI equivalent, handy from outside the app dir or in non-pnpm workflows.

Public sign-up is disabled, so hogsend setup does not create a Studio admin. Create the first admin from your shell with hogsend studio admin create (the scaffold wraps this as pnpm studio:admin), or set STUDIO_ADMIN_EMAIL (+ optional STUDIO_ADMIN_PASSWORD) and let the API mint it on boot into an empty user table.

Want setup and run in one command? hogsend dev is the superset: it runs these same steps (skipping any infra that's already up), then spawns the API + worker, waits for health, and prints the local URLs.

hogsend setup [--cwd <dir>] [--yes] [--json]

Options

OptionDescription
--cwd <dir>Project root to run in (defaults to the current directory).
--yes, -ySkip confirmation prompts (assume yes). Implied by --json.
--jsonRun non-interactively and emit a single JSON result document.
-h, --helpShow this help.

Run hogsend doctor afterwards to verify the instance is healthy.

On this page