# @inst-cli/template-utils

Latest version **1.0.7** (published 2019-09-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @inst-cli/template-utils
pnpm add @inst-cli/template-utils
yarn add @inst-cli/template-utils
bun add @inst-cli/template-utils
```

## 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.0.7 |
| Published | 2019-09-06 |
| First published | 2019-08-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jared Lunde |
| Maintainers | jaredlunde |

## Links

- npm: https://www.npmjs.com/package/@inst-cli/template-utils
- Repository: https://github.com/jaredLunde/inst-cli
- Homepage: https://github.com/jaredLunde/inst-cli/tree/master/template-utils#readme
- Issues: https://github.com/jaredLunde/inst-cli/issues
- npm.io page: https://npm.io/package/@inst-cli/template-utils

## Dependencies (6)

- [ini](https://npm.io/package/ini.md) ^1.3.5
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [fuzzy](https://npm.io/package/fuzzy.md) ^0.1.3
- [find-package-json](https://npm.io/package/find-package-json.md) ^1.1.0
- [inquirer-autocomplete](https://npm.io/package/inquirer-autocomplete.md) ^0.12.2
- [inquirer-checkbox-plus-prompt](https://npm.io/package/inquirer-checkbox-plus-prompt.md) ^1.0.1

## Recent versions

- 1.0.7 (latest) — 2019-09-06
- 1.0.6 — 2019-09-06
- 1.0.5 — 2019-09-06
- 1.0.4 — 2019-09-02
- 1.0.2 — 2019-08-31
- 1.0.1 — 2019-08-25
- 1.0.0 — 2019-08-24

## README

# inst-cli
A workspace manager integrated with Yarn for quickly constructing workspaces from boilerplates
using a basic template engine and integrated CLI prompts.

### Installation
`yarn global add inst-cli`

--------------------------------------------------------------------------------
```bash
# Creates a new boilerplate in the current working directory
inst template @stellar-apps/serverless-react-app

# Creates a new workspace with the `@stellar-apps/serverless-react-app` boilerplate
inst add @stellar-apps/serverless-react-app
```
--------------------------------------------------------------------------------

## `inst-cli`
### `inst init [workspace]`
Creates a new Inst+Yarn workspace at the `path.join(process.env.CWD, workspace)`. The
workspace comes with a script called `inst` and you're encourage to use `yarn inst` 
instead of `inst` from here on out when inside the workspace.
- `workspace`
    - The name and directory of your new workspace.

----

### `yarn inst add [template] [name] [--cwd=directory]`
Adds a new package to your workspace installed from the `template` positional argument. 
If using `yarn inst`, the new package will automatically appear in the directory 
`[workspace]/packages/[name]`

- `template`
    - The NPM package, git repo, or local template to create a workspace from
    - **Examples**
```bash
yarn inst some-npm-inst-template
yarn inst file:/path/to/my/local/template
yarn inst https://github.com/jaredLunde/cool-github-inst-template
```
- `name`
    - The name of the new package in your workspace. If not provided you will be prompted 
      for a name.
- `--cwd`
    - Joins the process.cwd() to this path when creating the environment
    
----

### `inst template [template-name] [--cwd=directory]`
Creates a new blank template in the current working directory or `--cwd`. This template
can then be installed via `inst add` above.

- `template-name`
    - The name of the new template you're creating
- `--cwd`
    - Joins the process.cwd() to this path when creating the environment

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