Initialize a boilerplate to kickstart a project:

$ ngx init [options] [target-directory]

Options

-b, --boilerplate <boilerplate>

Boilerplate to initialize.

Format: [<github-username>/]<github-repository-name>.

  • if no boilerplate is specified, ngx-boilerplates/default is used
  • if only a <github-repository-name> is specified, ngx-boilerplates/<github-repository-name> is used
-f, --force

Overwrite existing file(s).

-h, --help

Output usage information.

Arguments

<target-directory>

Where to initialize the boilerplate.

  • if no target-directory is specified, the current directory is used

Examples

# Initialize ngx-boilerplates/default in current directory
$ ngx init

# Initialize ngx-boilerplates/default in directory new-project
$ ngx init new-project

# Initialize ngx-boilerplates/default in current directory
$ ngx init -b default

# Initialize github-username/github-repository-name in current directory
$ ngx init -b github-username/github-repository-name

What's next?