npmpackage.info

Gathering detailed insights and metrics for cliui

Other packages similar to cliui

@isaacs/cliui

8.0.2

easily create complex multi-column command-line-interfaces

@poppinss/cliui

6.4.3

Opinionated UI KIT for Command Line apps

@ikrong/cliui

0.0.3

cliui

@dumlj/feature-cliui

2.5.26

cliui

easily create complex multi-column command-line-interfaces.

9.0.1

373

ISC

JavaScript

7.66 kB

17,980,321,078 3.9

Installations

npm install cliui

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=20

Node Version

14.21.3

NPM Version

6.14.18 Score

99.1

Supply Chain

99.5

Quality

88.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

5

Total

139

Closed

66

Merged

68

Issues

Open

17

Total

30

Closed

13

Releases

v9.0.1

Updated on Mar 17, 2025

v9.0.0

Updated on Mar 16, 2025

v8.0.1

Updated on Oct 01, 2022

v8.0.0

Updated on Sep 30, 2022

cliui v7.0.4

v7.0.4

Updated on Nov 08, 2020

cliui v7.0.3

v7.0.3

Updated on Oct 16, 2020

View All 10 releases

Contributors

Unable to fetch Contributors

View All 20 Contributors

Languages

JavaScript

TypeScript

JavaScript (55.42%)

TypeScript (44.58%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

yargs

Download Statistics

Total Downloads

17,980,321,078

Last Day

17,503,162

Last Week

96,875,645

Last Month

403,724,094

Last Year

4,404,056,378

GitHub Statistics

ISC License

373 Stars

134 Commits

43 Forks

10 Watchers

10 Branches

20 Contributors

Updated on Mar 17, 2025

Bundle Size

26.20 kB

Minified

7.66 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

9.0.1

Package Id

cliui@9.0.1

Unpacked Size

56.02 kB

Size

18.73 kB

File Count

NPM Version

6.14.18

Node Version

14.21.3

Published on

Mar 17, 2025

Total Downloads

Cumulative downloads

Total Downloads

17,980,321,078

Dependencies

string-width strip-ansi wrap-ansi

Dev Dependencies

@types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser c8 chai chalk cross-env eslint eslint-plugin-import eslint-plugin-n gts mocha rimraf standardx typescript

cliui

nycrc config on GitHub

easily create complex multi-column command-line-interfaces.

Example

1npm i cliui@latest chalk@latest

1const ui = require('cliui')()
2const {Chalk} = require('chalk');
3const chalk = new Chalk();
4
5ui.div('Usage: $0 [command] [options]')
6
7ui.div({
8  text: 'Options:',
9  padding: [2, 0, 1, 0]
10})
11
12ui.div(
13  {
14    text: "-f, --file",
15    width: 20,
16    padding: [0, 4, 0, 4]
17  },
18  {
19    text: "the file to load." +
20      chalk.green("(if this description is long it wraps).")
21    ,
22    width: 20
23  },
24  {
25    text: chalk.red("[required]"),
26    align: 'right'
27  }
28)
29
30console.log(ui.toString())

Deno/ESM Support

As of v7 cliui supports Deno and ESM:

1import cliui from "cliui";
2import chalk from "chalk";
3// Deno: import cliui from "https://deno.land/x/cliui/deno.ts";
4
5const ui = cliui({})
6
7ui.div('Usage: $0 [command] [options]')
8
9ui.div({
10  text: 'Options:',
11  padding: [2, 0, 1, 0]
12})
13
14ui.div(
15  {
16    text: "-f, --file",
17    width: 20,
18    padding: [0, 4, 0, 4]
19  },
20  {
21    text: "the file to load." +
22      chalk.green("(if this description is long it wraps).")
23    ,
24    width: 20
25  },
26  {
27    text: chalk.red("[required]"),
28    align: 'right'
29  }
30)
31
32console.log(ui.toString())

Layout DSL

cliui exposes a simple layout DSL:

If you create a single ui.div, passing a string rather than an object:

\n: characters will be interpreted as new rows.
\t: characters will be interpreted as new columns.
\s: characters will be interpreted as padding.

as an example...

1var ui = require('./')({
2  width: 60
3})
4
5ui.div(
6  'Usage: node ./bin/foo.js\n' +
7  '  <regex>\t  provide a regex\n' +
8  '  <glob>\t  provide a glob\t [required]'
9)
10
11console.log(ui.toString())

will output:

1Usage: node ./bin/foo.js
2  <regex>  provide a regex
3  <glob>   provide a glob          [required]

Methods

1cliui = require('cliui')

cliui({width: integer})

Specify the maximum width of the UI being generated. If no width is provided, cliui will try to get the current window's width and use it, and if that doesn't work, width will be set to 80.

cliui({wrap: boolean})

Enable or disable the wrapping of text in a column.

cliui.div(column, column, column)

Create a row with any number of columns, a column can either be a string, or an object with the following options:

text: some text to place in the column.
width: the width of a column.
align: alignment, right or center.
padding: [top, right, bottom, left].
border: should a border be placed around the div?

cliui.span(column, column, column)

Similar to div, except the next row will be appended without a new line being created.

cliui.resetOutput()

Resets the UI elements of the current cliui instance, maintaining the values set for width and wrap.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/ci.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/release-please.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/release-please.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/release-please.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/yargs/cliui/release-please.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:21
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:44
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:56
Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:65
Warn: npmCommand not pinned by hash: .github/workflows/release-please.yml:21
Warn: npmCommand not pinned by hash: .github/workflows/release-please.yml:42
Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 0 out of 6 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3.9

/10

Last Scanned on 2025-03-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More