cli-helpers

cli-helper

Helper library for cli applications

Features

• Read from cli without missing from multiline pasting
• Typescript support

Installation

npm install cli-helper

You can also install cli-helper with pnpm, yarn, or slnpm

Usage Example

import { createIO } from 'cli-helper'

async function main() {
  let io = createIO()
  for (;;) {
    let line = await io.question('> ')
    console.log('line:', line)
    if (line == 'exit') {
      break
    }
  }
  io.close()
}

main().catch(e => console.error(e))

Typescript Signature

import { ReadLineOptions } from 'readline'

/**
 * @description async io interface based on `readline.createInterface()`.
 * With internal buffer to avoid data lose when pasting multi-lines input.
 */
export function createIO(options?: {
  input?: ReadLineOptions['input']
  output?: ReadLineOptions['output']
}): {
  question: (question: string) => Promise<string>
  close: () => void
  flush: () => string[]
}

License

This project is licensed with BSD-2-Clause

This is free, libre, and open-source software. It comes down to four essential freedoms [ref]:

• The freedom to run the program as you wish, for any purpose
• The freedom to study how the program works, and change it so it does your computing as you wish
• The freedom to redistribute copies so you can help others
• The freedom to distribute copies of your modified versions to others