Installation

One command, under a minute. We've all spent longer deciding what to name a variable.

npm (recommended)

Install seedorm as a project dependency or globally to use the CLI anywhere.

As a project dependency

$ npm install seedorm

This installs the library and makes the seedorm CLI available via npx seedorm.

Global install

$ npm install -g seedorm

After global install, the seedorm command is available system-wide. You can verify with:

$ seedorm --version
0.2.0

Requirements

  • Node.js 18+

Optional peer dependencies

If you plan to use a SQL database, install the corresponding driver:

# PostgreSQL (supported now)
$ npm install pg
# MySQL (coming soon)
$ npm install mysql2

These are only needed when you switch your adapter config to a SQL database. The JSON adapter (default) has zero additional dependencies. It's just your code and a JSON file. Beautiful.

Verify installation

After installation, initialize a project and verify everything works:

$ mkdir my-project && cd my-project
$ seedorm init
✓  Created seedorm.config.json
✓  Created data/ directory
✓  Created migrations/ directory

Next: follow the Getting Started guide to build your first model.

Future install methods

We have big plans. Well, medium plans. These are coming eventually:

  • brew install seedorm: Homebrew formula
  • curl -fsSL https://seedorm.dev/install.sh | sh: standalone binary