https://github.com/sindresorhus/cli-boxes
Boxes for use in the terminal
https://github.com/sindresorhus/cli-boxes
Last synced: 10 months ago
JSON representation
Boxes for use in the terminal
- Host: GitHub
- URL: https://github.com/sindresorhus/cli-boxes
- Owner: sindresorhus
- License: mit
- Created: 2016-03-01T08:10:47.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T04:54:36.000Z (over 1 year ago)
- Last Synced: 2025-03-25T18:07:39.263Z (12 months ago)
- Language: TypeScript
- Size: 17.6 KB
- Stars: 98
- Watchers: 6
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- stars - cli-boxes
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