jordan-eckowitz / boil-cli

CLI tool - boilerplate template manager and generator

About

A boilerplate template manager and generator

Check out the full documentation here: https://jordan-eckowitz.github.io/boil-cli-docs

• About
• Usage
• Commands

Usage

$ npm install -g boil-cli-tool
$ boil COMMAND
running command...
$ boil (-v|--version|version)
boil-cli-tool/1.1.1 darwin-x64 node-v12.13.1
$ boil --help [COMMAND]
USAGE
  $ boil COMMAND
...

Commands

• boil create [NAME]
• boil create-function [NAME]
• boil help [COMMAND]
• boil init
• boil list
• boil up TEMPLATE

boil create [NAME]

create a new boilerplate template

USAGE
  $ boil create [NAME]

ARGUMENTS
  NAME  template name

OPTIONS
  -a, --args=args  local template args
  -h, --help       show CLI help

EXAMPLES
  $ boil create person --args name,surname,age
  $ boil create person -a name,surname,age

See code: src/commands/create.ts

boil create-function [NAME]

create a new boilerplate template function

USAGE
  $ boil create-function [NAME]

ARGUMENTS
  NAME  template function name

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ boil create-function timestamp

See code: src/commands/create-function.ts

boil help [COMMAND]

display help for boil

USAGE
  $ boil help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

boil init

create a new boilerplate directory

USAGE
  $ boil init

OPTIONS
  -h, --help  show CLI help

See code: src/commands/init.ts

boil list

list all boil commands

USAGE
  $ boil list

OPTIONS
  -h, --help  show CLI help

See code: src/commands/list.ts

boil up TEMPLATE

generate boilerplate from one of the templates

USAGE
  $ boil up TEMPLATE

ARGUMENTS
  TEMPLATE  call up a template defined in the '.boilerplate' directory

OPTIONS
  -h, --help  show CLI help

EXAMPLES
  $ boil up component --name App --filetype js
  $ boil up component -n App -ft js

  run boil list to see all available boilerplate templates

See code: src/commands/up.ts

boil-cli's Issues

[Feature] Configurable template variable escape characters

This is the best simple template/boilerplate generator CLI based on NodeJS I could find. However, currently it does not work on Windows because <,>, and | are illegal characters in directory and file names. This could be addressed by providing an option to configure the escape characters (maybe during boil init).
So instead of

<| someValue |>

we could specify to escape with e.g. {%, %}

{% someValue %}