# cli-width

> Get stdout window width, with two fallbacks, tty and then a default.

Latest version **4.1.0** (published 2023-08-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install cli-width
pnpm add cli-width
yarn add cli-width
bun add cli-width
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.1.0 |
| Published | 2023-08-05 |
| First published | 2015-01-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 12 |
| Dependencies | 0 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Ilya Radchenko |
| Maintainers | knownasilya, sboudrias |

## Links

- npm: https://www.npmjs.com/package/cli-width
- Repository: https://github.com/knownasilya/cli-width
- Issues: https://github.com/knownasilya/cli-width/issues
- npm.io page: https://npm.io/package/cli-width

## Recent versions

- 4.1.0 (latest) — 2023-08-05
- 4.0.0 — 2022-03-29
- 3.0.0 — 2020-04-14
- 2.2.1 — 2020-04-14
- 2.2.0 — 2017-08-22
- 2.1.1 — 2017-08-22
- 2.1.0 — 2016-02-15
- 2.0.0 — 2016-02-08
- 1.1.1 — 2016-01-26
- 1.1.0 — 2015-10-16
- 1.0.1 — 2015-01-22
- 1.0.0 — 2015-01-21

## README

# cli-width

Get stdout window width, with four fallbacks, `tty`, `output.columns`, a custom environment variable and then a default.

[![npm version](https://badge.fury.io/js/cli-width.svg)](http://badge.fury.io/js/cli-width)
[![Build Status](https://travis-ci.org/knownasilya/cli-width.svg)](https://travis-ci.org/knownasilya/cli-width)
[![Coverage Status](https://coveralls.io/repos/knownasilya/cli-width/badge.svg?branch=master&service=github)](https://coveralls.io/github/knownasilya/cli-width?branch=master)

Tested against Node v12 to v20.
Includes TypeScript types.

## Usage

```
npm install --save cli-width
```

```js
const cliWidth = require('cli-width');

cliWidth(); // maybe 204 :)
```

You can also set the `CLI_WIDTH` environment variable.

If none of the methods are supported, and the environment variable isn't set,
the default width value is going to be `0`, that can be changed using the configurable `options`.

## API

### cliWidth([options])

`cliWidth` can be configured using an `options` parameter, the possible properties are:

- **defaultWidth**\<number\> Defines a default value to be used if none of the methods are available, defaults to `0`
- **output**\<object\> A stream to be used to read width values from, defaults to `process.stdout`
- **tty**\<object\> TTY module to try to read width from as a fallback, defaults to `require('tty')`

### Examples

Defining both a default width value and a stream output to try to read from:

```js
const cliWidth = require('cli-width');
const ttys = require('ttys');

cliWidth({
  defaultWidth: 80,
  output: ttys.output,
});
```

Defines a different tty module to read width from:

```js
const cliWidth = require('cli-width');
const ttys = require('ttys');

cliWidth({
  tty: ttys,
});
```

## Tests

```bash
npm install
npm test
```

Coverage can be generated with `npm run coverage`.

---
_Source: https://npm.io/package/cli-width · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._