# instant-tools

> Command Line Tools for assisting with creating [`instant`](https://github.com/cjmyles/instant) applications and generating project files.

Latest version **0.0.17** (published 2018-12-17) · 0 weekly downloads

## Install

```sh
npm install instant-tools
pnpm add instant-tools
yarn add instant-tools
bun add instant-tools
```

Provides the command `instant`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.17 |
| Published | 2018-12-17 |
| First published | 2018-12-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 9 |
| Unpacked size | 23 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Craig Myles |
| Maintainers | cjmyles |
| Keywords | cli, tools |

## Links

- npm: https://www.npmjs.com/package/instant-tools
- Repository: https://github.com/cjmyles/instant-tools
- Homepage: https://github.com/cjmyles/instant-tools#readme
- Issues: https://github.com/cjmyles/instant-tools/issues
- npm.io page: https://npm.io/package/instant-tools

## Dependencies (9)

- [pify](https://npm.io/package/pify.md) ^4.0.1
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [config](https://npm.io/package/config.md) ^3.0.0
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [battlecry](https://npm.io/package/battlecry.md) ^0.3.4
- [commander](https://npm.io/package/commander.md) ^2.19.0
- [git-clone](https://npm.io/package/git-clone.md) ^0.1.0
- [firebase-tools](https://npm.io/package/firebase-tools.md) ^6.1.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

- 0.0.17 (latest) — 2018-12-17
- 0.0.16 — 2018-12-17

## README

# Instant Tools

Command Line Tools for assisting with creating [`instant`](https://github.com/cjmyles/instant) applications and generating project files.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
  - [create](#create)
  - [generate](#generate)
- [Contributing](#contributing)
- [License](#license)

## Installation

```bash
$ npm i instant-tools -g
```

You should now have access to the command `instant` in terminal.

## Usage

In order to execute a command, simply type the name of the command in teminal, after the word `instant`.

## Commands

### create

Create a new application.

```bash
$ instant create <type> <name> [-i]
```

type: string - the type of application, e.g 'react' or 'node'
name: string - the application name
-i: optional - install dependencies after the project templates have been cloned

#### Example Usage

```bash
$ instant create react my-react-app -i
```

### generate

Generate project files. Please ensure you execute this command within an existing project.

```bash
$ instant generate <template> <name>
```

template: string - the template to generate, e.g 'react/ui/component', 'react/ui/container', 'react/redux/module'
name: string - the file/variable name to use when creating template

## Contributing

We'd greatly appreciate any [contribution](CONTRIBUTING.md) you make.

## License

[MIT](LICENSE)

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