DocsGetting started

Installation

Three ways to install the seedkit CLI. No account needed for local-only use.


The seedkit CLI ships as a single npm package. Use whichever runtime you already have — npm, pnpm, or bun — or skip the global install entirely and run it on the fly with npx.

Run on the fly (no install)

npx seedkit-cli new --prompt "saas crm"

npx will fetch the latest version of seedkit-cli and run it. This is the fastest path if you just want to try it once.

Global install

npm install -g seedkit-cli
pnpm add -g seedkit-cli
bun add -g seedkit-cli

After installing, seedkit --version should print the installed version. (The package on npm is seedkit-cli, the binary it installs is seedkit.)

What works without an account

Local-only data generation works without any token:

  • seedkit preview — sample rows printed to your terminal
  • seedkit seed --url $YOUR_DATABASE_URL — insert into a Postgres you already control

The hosted side (ephemeral databases, the seed cache, mock APIs) requires a free account and a token. See Authentication.

Versioning

Releases follow semver. Breaking changes only on majors. The --from-cache invariant (cached SQL replays byte-identically across versions) is upheld within a major version; major-version bumps may invalidate cache keys, in which case the cache transparently regenerates on the next run.

Next