# cli-boxes

> Boxes for use in the terminal

Latest version **4.0.1** (published 2024-08-04) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.0.1 |
| Published | 2024-08-04 |
| First published | 2016-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=18.20 <19 \|\| >=20.10 |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 112 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | cli, box, boxes, terminal, term, console, ascii, unicode, border, text, json |

## Links

- npm: https://www.npmjs.com/package/cli-boxes
- Repository: https://github.com/sindresorhus/cli-boxes
- Homepage: https://github.com/sindresorhus/cli-boxes#readme
- Issues: https://github.com/sindresorhus/cli-boxes/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/cli-boxes

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 4.0.1 (latest) — 2024-08-04
- 4.0.0 — 2024-04-30
- 3.0.0 — 2021-01-16
- 2.2.1 — 2020-08-31
- 2.2.0 — 2019-04-30
- 2.1.0 — 2019-04-05
- 2.0.0 — 2019-02-03
- 1.0.0 — 2016-03-01

## README

# cli-boxes

> Boxes for use in the terminal

The list of boxes is just a [JSON file](boxes.json) and can be used anywhere.

## Install

```sh
npm install cli-boxes
```

## Usage

```js
import cliBoxes from 'cli-boxes';

console.log(cliBoxes.single);
/*
{
	topLeft: '┌',
	top: '─',
	topRight: '┐',
	right: '│',
	bottomRight: '┘',
	bottom: '─',
	bottomLeft: '└',
	left: '│'
}
*/
```

## API

### cliBoxes

#### `single`

```
┌────┐
│    │
└────┘
```

#### `double`

```
╔════╗
║    ║
╚════╝
```

#### `round`

```
╭────╮
│    │
╰────╯
```

#### `bold`

```
┏━━━━┓
┃    ┃
┗━━━━┛
```

#### `singleDouble`

```
╓────╖
║    ║
╙────╜
```

#### `doubleSingle`

```
╒════╕
│    │
╘════╛
```

#### `classic`

```
+----+
|    |
+----+
```

#### `arrow`

```
↘↓↓↓↓↙
→    ←
↗↑↑↑↑↖
```

## Related

- [boxen](https://github.com/sindresorhus/boxen) - Create boxes in the terminal

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