Welcome to CLIUI-Lite: A Powerful and Lightweight Command Line Interface Library

CLIUI-Lite is a versatile and lightweight library designed to help developers create elegant command line interfaces with ease. This tool can enhance your CLI projects, making them more user-friendly and visually appealing. In this guide, we will explore dozens of useful APIs offered by CLIUI-Lite, complete with code snippets and a practical application example.

Getting Started

First, install the CLIUI-Lite library:

  npm install cliui-lite

API Examples

Here are some key APIs provided by CLIUI-Lite:

Creating a User Interface

Use the ui() function to initiate the UI object:

  const cliui = require('cliui-lite')
  const ui = cliui()

Adding Text Blocks

The .span() method allows you to add text blocks to your UI:

  ui.span('Hello, World!')

Text blocks can also be styled:

  ui.span(
    { text: 'Name:', padding: [0, 4, 0, 0] },
    { text: 'John Doe' }
  )

Creating Columns

The .div() method is used to create columns:

  ui.div(
    { text: 'Column 1', width: 20 },
    { text: 'Column 2', width: 20 }
  )

Adding Padding and Border

You can add padding and border to texts:

  ui.div(
    {
      text: 'Padded and Bordered Text',
      padding: [1, 2, 1, 2],
      border: true
    }
  )

Rendering the UI

Once the UI components are added, render it using the .toString() method:

  console.log(ui.toString())

CLI Application Example

Let’s create a simple CLI application using the introduced APIs:

  const cliui = require('cliui-lite')
  const ui = cliui()

  ui.div(
    { text: 'Welcome to My CLI App', padding: [1, 2, 1, 2], border: true }
  )

  ui.div(
    { text: 'ID:', padding: [0, 4, 0, 0] },
    { text: '12345' }
  )

  ui.div(
    { text: 'Name:', padding: [0, 4, 0, 0] },
    { text: 'Jane Doe' }
  )

  console.log(ui.toString())

And there you have it—a simple yet effective CLI application using CLIUI-Lite!

Hash: b3f2549fad907c1da1947bbfe62c19ad33df1c15c9b388bbcaf9b4af16795eba