# @starters/core

> The core logic for managing templates.

Latest version **1.8.0** (published 2022-04-14) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @starters/core
pnpm add @starters/core
yarn add @starters/core
bun add @starters/core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.8.0 |
| Published | 2022-04-14 |
| First published | 2020-12-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 13.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jake Hamilton |
| Maintainers | jakehamilton |
| Keywords | starters, cli, bootstrap, boilerplate |

## Links

- npm: https://www.npmjs.com/package/@starters/core
- npm.io page: https://npm.io/package/@starters/core

## Dependencies (9)

- [kleur](https://npm.io/package/kleur.md) latest
- [is-url](https://npm.io/package/is-url.md) latest
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [copy-dir](https://npm.io/package/copy-dir.md) ^1.3.0
- [enquirer](https://npm.io/package/enquirer.md) ^2.3.6
- [npm-which](https://npm.io/package/npm-which.md) ^3.0.1
- [render-in-place](https://npm.io/package/render-in-place.md) ^1.0.2
- [@littlethings/log](https://npm.io/package/@littlethings/log.md) ^3.0.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.8.0 (latest) — 2022-04-14
- 1.7.2 — 2021-06-14
- 1.7.1 — 2021-01-22
- 1.7.0 — 2020-12-31
- 1.6.0 — 2020-12-31
- 1.5.0 — 2020-12-31
- 1.4.0 — 2020-12-31
- 1.3.0 — 2020-12-28
- 1.2.1 — 2020-12-28
- 1.2.0 — 2020-12-28
- 1.1.0 — 2020-12-28
- 1.0.2 — 2020-12-27
- 1.0.1 — 2020-12-27

## README

# @starters/core

This module contains the internals for handling starter templates.

## Install

```shell
npm install --save @starters/core
```

## Usage

```js
const starters = require("@starters/core");

await starters.create(
    "/path/to/project",
    "my-template-name",
    "my-package-name",
    "/my/cache"
);
```

### `starters.create(where, template [, name [, cache]])`

This function creates a new project from a template. The `where` parameter is a path
to the location that the project should be created at. The `template` parameter is either
the name of an NPM package _or_ the address of a Git repository.

Here are some examples for the `template` parameter:

```
my-npm-package
@my-scope/my-npm-package

git@github.com:my-user/my-project
```

The `name` parameter specifies a package name that is passed to the template. The `cache`
parameter is used to specify a directory to install NPM template packages to. Both of these
parameters are optional.

---
_Source: https://npm.io/package/@starters/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._