Node.js scaffolding CLI

Install Quickstart CLI and create projects from trusted templates.

Quickstart CLI provides the quick command for generating application and deployment projects, wiring project metadata, installing template dependencies, and preparing the first Git commit.

Install CLI View Commands
quickstart 
$ quick new app customer-portal --template sql
Creating directory...
Initializing git...
Initializing npm...
Installing template...
Rendering selected template...
You're all set!

$ cd customer-portal
$ npm start
Before You Start

Prerequisites

Install these tools before running Quickstart CLI. The CLI checks the runtime tools before scaffolding a project.

Java 17+

Required to run the packaged CLI jar and native launcher.

Node.js 20.20.0+

Required by the generated Node.js projects and template installation flow.

npm 10.8.2+

Used to install templates, install dependencies, and update the CLI.

Git

Used to initialize the generated project and create the initial commit.

First run note: if the Quickstart npm registry is not configured, the CLI configures npm and may ask you to log in to the Quickstart registry.

Setup

Installation Process

Choose the installation path that matches your operating system, then verify the quick command.

Install on Linux

Download the Debian package, install it, then verify the executable.

Linux
sudo dpkg -i quickstart-cli_0.0.1_all.deb
quick --version

Install on macOS

Download the portable archive, unpack it, and add the bin directory to your PATH.

macOS archive
tar -xzf quickstart-cli-0.0.1-macos.tar.gz
export PATH="$PWD/quickstart-cli-0.0.1-macos/bin:$PATH"
quick --version

Install on Windows

Download the Windows archive, extract it, and run the CLI from the bin folder.

Windows archive
quickstart-cli-0.0.1-windows\bin\quick.bat --version
Commands

How To Use

The main command is quick new. It can create an app or a deployment project and can ask for missing values interactively.

Create an app
quick new app my-app --template sql
Create a deployment project
quick new deployment my-deployment --template sql
Use interactive prompts
quick new
Update the CLI
quick update
Reference

Help Commands

Use these commands to inspect all available options directly from the CLI.

Command Purpose
quick -h Show top-level help, available commands, and common examples.
quick --help Same as quick -h.
quick new -h Show arguments and options for creating a new app or deployment project.
quick new --help Same as quick new -h.
quick --version Print the installed Quickstart CLI version.
New Command

Common Options

These are the options users most often need while scaffolding a project.

Option Description
-t, --template TEMPLATE Select the template to install, for example sql.
-n, --package-name PACKAGE Set the generated package name.
--env ENV Use a saved environment profile.
-e, --new-env Create and use a new environment profile.
--author-name NAME Set the author name in generated metadata.
--author-email EMAIL Set the author email in generated metadata.
--company-name NAME Set the company name used by generated metadata and scoped packages.