seed
Reference
Seed CLI

Seed CLI

You can use the Command-Line Interface (CLI) provided by @snaplet/seed to manage your Seed Client from a terminal window.

init

The npx @snaplet/seed init command is used to initialize Seed locally for your project.

Arguments

  • <directory> - Directory path to initialize Snaplet Seed in.

Usage

Initialize Seed in the current directory:

>_ terminal

npx @snaplet/seed init

Initialize Seed in a specific directory:

>_ terminal

npx @snaplet/seed init prisma/seed

If you initialize Seed in a specific directory, you will have to specify the --config option in the other commands.

login

The npx @snaplet/seed login command is used to log into your Snaplet account.

Options

Usage

Interactive login:

>_ terminal

npx @snaplet/seed login

Login with access token:

>_ terminal

npx @snaplet/seed login --access-token <access-token>

sync

The npx @snaplet/seed sync command is used to synchronize your database schema with Seed Client.

Usage

>_ terminal

npx @snaplet/seed sync

generate

The npx @snaplet/seed generate command is used to generate the necessary assets for Seed Client.

Usage

>_ terminal

npx @snaplet/seed generate

Common options

  • --config <path> - Path to the config file.

Usage

>_ terminal

npx @snaplet/seed --config prisma/seed/seed.config.ts sync

link

The npx @snaplet/seed link command is used to link your local directory to a Snaplet Project.

Usage

>_ terminal

npx @snaplet/seed link

Global options

  • --help - Show help.
  • --version - Show version number.