@breadcrumb-sh/cli

@breadcrumb-sh/cli

CLI for Breadcrumb: database migrations for the Breadcrumb schema. Installs the breadcrumb command.

npm i -D @breadcrumb-sh/cli
# or run without installing:
npx breadcrumb <command>

Commands

breadcrumb migrate

Applies the Breadcrumb schema directly to your database, creating tables and adding any missing columns.

breadcrumb migrate [--database <url|path>]

The target comes from --database, or $DATABASE_URL if omitted. A postgres:// or postgresql:// URL uses the Postgres adapter; anything else is treated as a SQLite file path.

breadcrumb migrate --database postgres://user:pass@localhost:5432/app
breadcrumb migrate --database ./prod.db
DATABASE_URL=postgres://… breadcrumb migrate

breadcrumb generate

Writes a reviewable .sql migration file instead of touching your database. Commit it and apply it with your own tooling.

breadcrumb generate [--database <url|path>] [--dialect postgres|sqlite] \
                    [--out <dir>] [--name <name>]

Flag	Default	Description
--database	$DATABASE_URL	Diff against a live database, emitting only the delta.
--dialect	none	Emit a fresh full schema when no database is given (postgres or sqlite).
--out	./breadcrumb/migrations	Output directory.
--name	breadcrumb	Filename suffix.

Pass either --database (to diff a live DB) or --dialect (for a fresh schema). Files are named <timestamp>_<name>.sql.

# Fresh schema for a new Postgres database
breadcrumb generate --dialect postgres

# Delta against a live database, custom name and dir
breadcrumb generate --database $DATABASE_URL --name init --out ./db/migrations

License

MIT