Skip to content

installation.md

Latest commit

 

History

History
61 lines (40 loc) · 1.11 KB

installation.md

File metadata and controls

61 lines (40 loc) · 1.11 KB

Installation

starter-structure-cli can be used with npx, the standard npm create flow, or developed locally from this repository.

Requirements

  • Node.js 18 or later
  • npm 9 or later

Use From npm

Run the CLI without installing it globally:

npx starter-structure-cli my-app

Run it with the npm create convention:

npm create starter-structure-cli@latest my-app

Or install it globally:

npm install -g starter-structure-cli
starter-structure-cli my-app

If you run npm install starter-structure-cli, npm will only install the package into the current directory. It will not execute the scaffolder for you.

Local Repository Setup

Install dependencies:

npm install

Verify the CLI is available:

node ./bin/starter-structure-cli.js --help

Build generated templates from template-sources:

npm run build:architecture-stubs
npm run build:templates
npm run check:create-package

Validate generated templates:

npm run check:templates

The package automatically rebuilds templates during npm pack through the prepack script.