create-piral-instance/README.md

The NPM initializer to scaffold a new Piral instance.

[![Piral Logo](https://github.com/smapiot/piral/raw/main/docs/assets/logo.png)](https://piral.io)

# [Create Piral Instance](https://piral.io) · [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/smapiot/piral/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/create-piral-instance.svg?style=flat)](https://www.npmjs.com/package/create-piral-instance) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://jestjs.io) [![Community Chat](https://dcbadge.vercel.app/api/server/kKJ2FZmK8t?style=flat)](https://discord.gg/kKJ2FZmK8t)

`create-piral-instance` is a command-line tool that can also be used via NPM. It should make scaffolding a new Piral instance as simple as possible.

## Usage

There are different ways of using it.

You can either install the tool globally and run it from there, or you use `npx` for this duty:

```sh
npx create-piral-instance
```

Alternatively, you can use `npm init` to run it.

```sh
npm init piral-instance
```

There are no command line parameters. Every input will be supplied via a command line prompt in an interactive manner. If you look for a tool to automate this (e.g., via command line parameters) use the `piral-cli`.

## Documentation

For details on the available commands check out the [documentation at Piral](https://docs.piral.io) or [on GitHub](https://github.com/smapiot/piral/tree/main/docs/commands).

## License

Piral is released using the MIT license. For more information see the [license file](./LICENSE).