Quickstart CLI

Command line scaffolding that does the boring parts.

Create an app or deployment, choose an environment, render templates, install dependencies, and start from a clean git commit.

Run the first command Commands 
$ quick --version
quick 0.0.1

$ quick new app billing-api --template sql
OK toolchain ready
? Select env: production
OK Rendering base template
OK Rendering selected template
OK Installing dependencies
You're all set!
Run 'npm start' to start your project

Get started

Run the CLI directly.

The website now focuses on the commands developers type after Quickstart is available on their machine.

quick --version
quick --help
quick new app my-app --template sql

Core commands.

Keep the setup simple: verify the binary, ask for help, then scaffold an app or deployment.

  1. 1
    Check install
    quick --version
  2. 2
    View help
    quick --help
  3. 3
    Create app
    quick new app billing-api --template sql
  4. 4
    Create deployment
    quick new deployment billing-deploy

Requirements

Keep the toolchain predictable.

  • JDK 17 or newer
  • Node.js 20.20.1 or newer
  • npm 10.8.2 or newer
  • A configured `quick` command on your path

Commands

The first command is the main workflow.

The CLI exposes `quick new` for app or deployment scaffolding and `quick --version` for install checks.

quick new

Create a sub app or deployment app with guided prompts and options for author, company, client, database, dialect, package, and template.

quick --version

Verify the installed binary. The current repo version reports `quick 0.0.1`.

Error states

Failures are designed to stand apart from prompts and success messages, making terminal output easier to scan.