CLI Reference

Complete reference for all Kickstart Express command-line options and usage patterns.

Basic Usage

kickstart-express [options]

When run without any options, Kickstart Express starts in interactive mode, guiding you through project configuration.

-h, --help

Display help information and exit.

kickstart-express --help

-V, --version

Display version number and exit.

kickstart-express --version

-n, --name <project-name>

Specify the project name. This will be used as the directory name.

kickstart-express --name my-awesome-api

RequiredYes (if not provided, you'll be prompted)

-l, --language <ts|js>

Choose the programming language for your project.

kickstart-express --language ts   # TypeScript
kickstart-express --language js   # JavaScript

Defaultts (TypeScript)

-d, --docker

Include Docker configuration (Dockerfile and docker-compose.yml).

kickstart-express --docker

Defaultfalse

-s, --src

Create src folder structure instead of root-level files.

kickstart-express --src

Defaultfalse

--structured

Use structured architecture with controllers, services, and routes separation.

kickstart-express --structured

Defaultfalse

NoteAutomatically enables --src when used

Start the interactive CLI to configure your project step by step:

kickstart-express

Create a TypeScript project with all features enabled:

kickstart-express -n my-awesome-api -l ts -d -s --structured

Create a basic JavaScript project:

kickstart-express --name simple-app --language js

Create a project with Docker configuration:

kickstart-express --name docker-api --docker --src

Provide some options and be prompted for the rest:

kickstart-express --name my-app --docker