Home
Docs
GitHub
Pricing
Blog
Log In

Run Sandworm Audit for your App

Get started
Hold on, we're currently generating a fresh version of this report
Generated on May 8, 2024 via pnpm

boxen 5.1.2

Create boxes in the terminal
Package summary
Share
0
issues
3
licenses
16
MIT
1
ISC
1
(MIT OR CC0-1.0)
Package created
21 Dec 2015
Version published
17 Sep 2021
Maintainers
1
Total deps
18
Direct deps
8
License
MIT

Issues

0
This package has no issues

Licenses

MIT License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
Cannot
hold-liable
Must
include-copyright
include-license
16 Packages, Including:
ansi-regex@5.0.1
ansi-styles@4.3.0
boxen@5.1.2
camelcase@6.3.0
chalk@4.1.2
cli-boxes@2.2.1
color-convert@2.0.1
color-name@1.1.4
emoji-regex@8.0.0
has-flag@4.0.0
is-fullwidth-code-point@3.0.0
string-width@4.2.3
strip-ansi@6.0.1
supports-color@7.2.0
widest-line@3.1.0
wrap-ansi@7.0.0

ISC License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
Cannot
hold-liable
Must
include-copyright
include-license
1 Packages, Including:
ansi-align@3.0.1

(MIT OR CC0-1.0)

Public Domain
1 Packages, Including:
type-fest@0.20.2
Disclaimer

This deed highlights only some of the key features and terms of the actual license. It is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

Sandworm is not a law firm and does not provide legal services. Distributing, displaying, or linking to this deed or the license that it summarizes does not create a lawyer-client or any other relationship.

Direct Dependencies

8
All Dependencies CSV
β“˜ This is a list of boxen 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.
NameVersionSizeLicenseTypeVulnerabilities
ansi-align3.0.13.17 kBISC
prod
camelcase6.3.03.75 kBMIT
prod
chalk4.1.211.31 kBMIT
prod
cli-boxes2.2.12.52 kBMIT
prod
string-width4.2.32.33 kBMIT
prod
type-fest0.20.236.35 kB(MIT OR CC0-1.0)
prod
widest-line3.1.01.87 kBMIT
prod
wrap-ansi7.0.04.22 kBMIT
prod

Visualizations

Frequently Asked Questions

What does boxen do?

"Boxen" is an incredibly handy npm package used to create styled boxes in the terminal. With boxen, your terminal need not be a boring streak of plain text but can incorporate visually appealing and perfectly formatted boxes to emphasize or segregate messages. Text, border styles, padding, margin settings, and more can be easily modified for an enhanced user experience.

How do you use boxen?

Using "boxen" is both versatile and straightforward. The initial step involves adding it to your project using npm install boxen. After installing the module, import it using import boxen from 'boxen'; and make use of it in your files.

For creating a simple box with padding, the code would look like this:

console.log(boxen('unicorn', {padding: 1}));

For adding a margin and using a double border style, you can modify the second parameter passed in the boxen() function like so:

console.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'}));

To add a title to your box, utilize the title and titleAlignment options:

console.log(boxen('unicorns love rainbows', {title: 'magical', titleAlignment: 'center'}));

You can also set a fixed width or height for your box, use a fullscreen option, set padding and margin, adjust the alignment of the text, and more. The combination of these options offers robust customizability to shape the box precisely as per your needs.

Where are the boxen docs?

The comprehensive documentation for "boxen" can be found right in its README on the GitHub repository, available at https://github.com/sindresorhus/boxen/. The full list of options that you can pass to customize your boxes, the acceptable values for these options, and additional examples showcasing the package's capability are all featured in the README. Consult it to ascertain the various creative ways you can incorporate boxen in your console output.