3 [![Build Status](https://travis-ci.org/yargs/cliui.svg)](https://travis-ci.org/yargs/cliui)
4 [![Coverage Status](https://coveralls.io/repos/yargs/cliui/badge.svg?branch=)](https://coveralls.io/r/yargs/cliui?branch=)
5 [![NPM version](https://img.shields.io/npm/v/cliui.svg)](https://www.npmjs.com/package/cliui)
6 [![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)
8 easily create complex multi-column command-line-interfaces.
13 var ui = require('cliui')({
17 ui.div('Usage: $0 [command] [options]')
31 text: "the file to load." +
32 chalk.green("(if this description is long it wraps).")
37 text: chalk.red("[required]"),
42 console.log(ui.toString())
45 <img width="500" src="screenshot.png">
49 cliui exposes a simple layout DSL:
51 If you create a single `ui.row`, passing a string rather than an
54 * `\n`: characters will be interpreted as new rows.
55 * `\t`: characters will be interpreted as new columns.
56 * `\s`: characters will be interpreted as padding.
61 var ui = require('./')({
66 'Usage: node ./bin/foo.js\n' +
67 ' <regex>\t provide a regex\n' +
68 ' <glob>\t provide a glob\t [required]'
71 console.log(ui.toString())
77 Usage: node ./bin/foo.js
78 <regex> provide a regex
79 <glob> provide a glob [required]
85 cliui = require('cliui')
88 ### cliui({width: integer})
90 Specify the maximum width of the UI being generated.
92 ### cliui({wrap: boolean})
94 Enable or disable the wrapping of text in a column.
96 ### cliui.div(column, column, column)
98 Create a row with any number of columns, a column
99 can either be a string, or an object with the following
102 * **width:** the width of a column.
103 * **align:** alignment, `right` or `center`.
104 * **padding:** `[top, right, bottom, left]`.
105 * **border:** should a border be placed around the div?
107 ### cliui.span(column, column, column)
109 Similar to `div`, except the next row will be appended without
110 a new line being created.