Superflare CLI

Introduction

The Superflare CLI is a tool for building out your local Superflare app. In most cases, it's a wrapper around the wrangler CLI, but it also provides some additional functionality.

$ npx superflare

Commands:
  superflare migrate           🏗️ Migrate your database and update types
  superflare dev [entrypoint]  🏄 Start the development server
  superflare generate          🌇 Scaffold useful things  [aliases: g]
  superflare new [name]        🎸 Create a new Superflare project
  superflare console           🔮 Open an interactive developer console  [aliases: c]
  superflare db                🗄️ Manage your database

Options:
  -v, --version  Show version number  [boolean]
  -h, --help     Show help  [boolean]

superflare migrate

The migrate command is one of the more useful commands in the Superflare CLI.

By default, it:

1. Compiles your Superflare TS migrations to Wrangler SQL migrations
2. (Optional with -f) Drops your local development database
3. Migrates your local database with npx wrangler d1 migrations apply DB
4. (Optional with -s) Seeds your local database
5. Parses the column types in your local database and syncs them to superflare.env.d.ts to be used by your Models

superflare dev

The dev command starts a local development server for your Superflare app. It's effectively a wrapper around wrangler dev --local. It will be more useful in the context of Cloudflare Pages because all bindings are passed via CLI flags, which can be tedious to type out.

npx superflare dev

superflare generate

Scaffold useful things in your Superflare app:

$ superflare generate

🌇 Scaffold useful things

Commands:
  superflare g job <name>        Generate a Job
  superflare g migration <name>  Generate a Migration
  superflare g model <name>      Generate a Model

superflare generate job

Generates a new Job with the given name.

superflare generate migration

Generates a new Migration with the given name.

superflare generate model

Generates a new Model with the given name.

Optional: -m or --migration will generate a migration for the model as well.

superflare new

Allows you to create a new Superflare app.

superflare console

Opens an interactive developer console for your Superflare app. You can access all your models and perform queries against your local database.

superflare db

$ superflare db

🗄️ Manage your database

Commands:
  superflare db seed  🌱  Seed your database with data

superflare db seed

Seeds your local database with data from your seed file.