npm package: @scafflater/scafflater-cli
Description: The Scafflater Cli
Author: Chico Ribas
Latest version: 1.0.47

# Scafflater Cli

[![Scafflater Cli](https://img.shields.io/badge/dynamic/xml?color=green&label=scafflater-cli&query=%2F%2F%2A%5B%40id%3D%22top%22%5D%2Fdiv%5B1%5D%2Fspan%5B1%5D&url=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40scafflater%2Fscafflater)](https://npmjs.org/package/@scafflater/scafflater-cli)
[![Downloads/week](https://img.shields.io/npm/dw/scafflater-cli.svg)](https://npmjs.org/package/scafflater-cli)
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![License](https://img.shields.io/npm/l/scafflater-cli.svg)](https://github.com/scafflater/scafflater-cli/blob/main/package.json)

<!-- toc -->
* [Scafflater Cli](#scafflater-cli)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @scafflater/scafflater-cli
$ scafflater-cli COMMAND
running command...
$ scafflater-cli (--version)
@scafflater/scafflater-cli/1.0.47 linux-x64 node-v18.20.4
$ scafflater-cli --help [COMMAND]
USAGE
  $ scafflater-cli COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`scafflater-cli help [COMMAND]`](#scafflater-cli-help-command)
* [`scafflater-cli init SOURCE`](#scafflater-cli-init-source)
* [`scafflater-cli partial:list`](#scafflater-cli-partiallist)
* [`scafflater-cli partial:run [PARTIAL_NAME]`](#scafflater-cli-partialrun-partial_name)

## `scafflater-cli help [COMMAND]`

Display help for scafflater-cli.

```
USAGE
  $ scafflater-cli help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  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](https://github.com/oclif/plugin-help/blob/v6.2.4/src/commands/help.ts)_

## `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](https://github.com/scafflater/scafflater/blob/v1.0.47/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](https://github.com/scafflater/scafflater/blob/v1.0.47/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](https://github.com/scafflater/scafflater/blob/v1.0.47/commands/partial/run.js)_
<!-- commandsstop -->