https://github.com/mihiraggarwal/realtio-npm

A simple node package to take in inputs and display outputs in realtime onto the CLI
https://github.com/mihiraggarwal/realtio-npm

command-line input-output npm-package realtime

Last synced: over 1 year ago
JSON representation

A simple node package to take in inputs and display outputs in realtime onto the CLI

• Host: GitHub
• URL: https://github.com/mihiraggarwal/realtio-npm
• Owner: mihiraggarwal
• Created: 2021-04-06T07:25:41.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-14T10:36:59.000Z (over 5 years ago)
• Last Synced: 2024-09-16T15:43:13.097Z (almost 2 years ago)
• Topics: command-line, input-output, npm-package, realtime
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/realtio
• Size: 213 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# realtio

![npm](https://img.shields.io/npm/v/realtio)

![npm bundle size](https://img.shields.io/bundlephobia/min/realtio)

A simple node package to take in inputs and display outputs in realtime onto the CLI.

## Why?

To help beginners learn how to use a specific tool, to help reduce errors during user inputs, or to just efficiently display preset outputs without having the user press enter every time.

## Installation

```

npm install realtio

```

## Parameters

### Input-output values

`Required`

- Key - input

- Value - output

### Prompt

`Optional`

Text, if any, to be displayed before the input.

## Example

![Code snippet](https://raw.githubusercontent.com/mihiraggarwal/realtio-npm/master/assets/demo.png)

![Demo GIF](https://raw.githubusercontent.com/mihiraggarwal/realtio-npm/master/assets/demo.gif)

CLI commands which don't engage any other directory can also be run directly by pressing enter.