Scafflater Cli

• Scafflater Cli
• Usage
• Commands

Usage

$ npm install -g @scafflater/scafflater-cli
$ scafflater-cli COMMAND
running command...
$ scafflater-cli (--version)
@scafflater/scafflater-cli/1.0.35 linux-x64 node-v16.20.2
$ scafflater-cli --help [COMMAND]
USAGE
  $ scafflater-cli COMMAND
...

Commands

• scafflater-cli help [COMMANDS]
• scafflater-cli init SOURCE
• scafflater-cli partial:list
• scafflater-cli partial:run [PARTIAL_NAME]

scafflater-cli help [COMMANDS]

Display help for scafflater-cli.

USAGE
  $ scafflater-cli help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for scafflater-cli.

See code: @oclif/plugin-help

scafflater-cli init SOURCE

Initializes the template in a output folder

USAGE
  $ scafflater-cli init SOURCE [-o <value>] [-c homeDir|tempDir] [-s
    git|githubClient|isomorphicGit|localFolder] [-p <value>] [-v <value>] [-d]

ARGUMENTS
  SOURCE  The template source

FLAGS
  -c, --cache=<option>           [default: homeDir] The cache strategy
                                 <options: homeDir|tempDir>
  -d, --debug                    Debug mode execution
  -o, --output=<value>           [default: ./] The output folder
  -p, --parameters=<value>...    [default: ] The parameters to init template. If the parameter is a dot separated name,
                                 it will be parsed as an object.
  -s, --templateSource=<option>  [default: git] Template source indicating how the template is fetched
                                 <options: git|githubClient|isomorphicGit|localFolder>
  -v, --version=<value>          [default: last] The template version

DESCRIPTION
  Initializes the template in a output folder
  ...

See code: commands/init.js

scafflater-cli partial:list

Lists available partials in template

USAGE
  $ scafflater-cli partial:list [-o <value>] [-c homeDir|tempDir] [-s git|githubClient|isomorphicGit|localFolder]

FLAGS
  -c, --cache=<option>           [default: homeDir] The cache strategy
                                 <options: homeDir|tempDir>
  -o, --output=<value>           [default: ./] The output folder
  -s, --templateSource=<option>  [default: git] Template source indicating how the template is fetched
                                 <options: git|githubClient|isomorphicGit|localFolder>

DESCRIPTION
  Lists available partials in template
  ...

See code: commands/partial/list.js

scafflater-cli partial:run [PARTIAL_NAME]

Runs a partial and append the result to the output folder

USAGE
  $ scafflater-cli partial:run [PARTIAL_NAME] [-t <value>] [-o <value>] [-c homeDir|tempDir] [-p <value>] [-s
    git|githubClient|isomorphicGit|localFolder] [-d]

ARGUMENTS
  PARTIAL_NAME  The partial name

FLAGS
  -c, --cache=<option>           [default: homeDir] The cache strategy
                                 <options: homeDir|tempDir>
  -d, --debug                    Debug mode execution
  -o, --output=<value>           [default: ./] The output folder
  -p, --parameters=<value>...    [default: ] The parameters to run partial. If the parameter is a dot separated name, it
                                 will be parsed as an object.
  -s, --templateSource=<option>  [default: git] Template source indicating how the template is fetched
                                 <options: git|githubClient|isomorphicGit|localFolder>
  -t, --template=<value>         The template which contains the partial to be run

DESCRIPTION
  Runs a partial and append the result to the output folder
  ...

See code: commands/partial/run.js