# vapor-cli

> The command line installer for vapor apps.

Latest version **1.0.0-beta.3** (published 2018-11-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install vapor-cli
pnpm add vapor-cli
yarn add vapor-cli
bun add vapor-cli
```

Provides the command `vapor-cli`.

## 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.0-beta.3 |
| Published | 2018-11-11 |
| First published | 2018-11-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 16.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | vapor |
| Maintainers | c-vapor |
| Keywords | vapor, cli, scaffold |

## Links

- npm: https://www.npmjs.com/package/vapor-cli
- Repository: https://github.com/c-phoniex/vapor-cli
- Homepage: https://github.com/c-phoniex/vapor-cli.git#readme
- Issues: https://github.com/c-phoniex/vapor-cli.git/issues
- npm.io page: https://npm.io/package/vapor-cli

## Dependencies (12)

- [npm](https://npm.io/package/npm.md) ^6.4.1
- [nopt](https://npm.io/package/nopt.md) ^4.0.1
- [async](https://npm.io/package/async.md) ^2.6.1
- [which](https://npm.io/package/which.md) ^1.3.1
- [colors](https://npm.io/package/colors.md) ^1.3.2
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.2
- [is-root](https://npm.io/package/is-root.md) ^2.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^6.2.0
- [multiline](https://npm.io/package/multiline.md) ^2.0.0
- [babel-register](https://npm.io/package/babel-register.md) ^6.26.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^2.5.0
- [babel-preset-env](https://npm.io/package/babel-preset-env.md) ^1.7.0

## 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.0.0-beta.3 (latest) — 2018-11-11
- 1.0.0-beta-2 — 2018-11-11
- 1.0.0-beta — 2018-11-11
- 1.0.0 — 2018-11-11

## README

# Vapor CLI

The command line installer for vapor apps.

## Requirements

You'll need the following software installed to get started.

  * [Node.js](http://nodejs.org) 8.0+: Use the installer provided on the NodeJS website.
  * [Git](http://git-scm.com/downloads): Use the installer for your OS. Windows users can also try [Git for Windows](http://git-for-windows.github.io/).

## Installing

The Vapor CLI is installed through npm.

```bash
npm install -g vapor-cli
```

This will add the `vapor` command to your system.

### Updating

The CLI periodically gets updates that add features or fix bugs. Use npm to upgrade the CLI to the newest version.

```bash
npm update -g vapor-cli
```

To check what version you currently have, use `-v`.

```bash
vapor -v
```

## Commands

### init

Starts the setup process for a new react web app project. The CLI will ask you which template you want to use and a folder name for the project.

```bash
vapor init
```
Create and use your own templates:

```bash
vapor init --repo https://github.com/username/template-name.git
```
Or create a PR to add your templates to the `vapor-cli/lib/util/templates.js` file.

### help

Lists all available commands in the CLI.

```bash
vapor help
```

## Credits
Inspired on [Foundation CLI](https://github.com/zurb/foundation-cli)

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