@janiscommerce/create NPM

:package: JanisCommerce Package Initializer

A package initializer for @janiscommerce npm packages

:hammer: Usage

npx @janiscommerce/create <package-name>

npm init @janiscommerce <package-name>

:mag: Get help on the CLI

You can also see the following docs within the CLI by running npx @janiscommerce/create --help

:round_pushpin: Positional arguments

package-name

Defines the name of the package to create. It will be automatically prefixed with the scope @janiscommerce/.

Example npx @janiscommerce/create cool-demo

This will create the @janiscommerce/cool-demo package

:wrench: Options

Every named option can be passed as a command line argument or set as an environment variable (prefixed with JANISCOMMERCE_CREATE_).
For example, verbose option can be passed as --verbose as a CLI argument or set as JANISCOMMERCE_CREATE_VERBOSE=true env var.

`--description` (alias `-d`)

Sets the package description both in the package.json and README.md

Example npx @janiscommerce/create cool-demo --description 'A cool package for a simple demo' Example npx @janiscommerce/create cool-demo -d 'A cool package for a simple demo'

`remote-type` (alias `-r`)

Selects how will the git remote be configured. Options are ssh (default) or http.

Example npx @janiscommerce/create cool-demo --remote-type http Example npx @janiscommerce/create cool-demo -r http

`github-username` (alias `-u`)

You can set you github username in the remote so you don't have to type it each time (http remote type only).

Example npx @janiscommerce/create cool-demo --remote-type http --github-username janis-commerce-admin Example npx @janiscommerce/create cool-demo --remote-type http -u janis-commerce-admin