Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including sum-up with all npm packages installed. Try it out:

var sumUp = require("sum-up")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

sum-up v3.0.1

Summarize package information


npm version Build Status Coverage Status

Summarize package information

const sumUp = require('sum-up');


It helps your CLI tool to display information with --help flag.


Use npm.

npm install sum-up


const sumUp = require('sum-up');

sumUp(pkgData [, option])

pkgData: Object
option: Object
Return: string

It joins the name, version, homepage and description properties (all is optional) of the first argument into a string colorized with ANSI escape code.


Type: boolean
Default: true if the environment supports colors, otherwise false

false omits all ANSI escape code from the string.

const data = {
  name: 'cli-name',
  version: '0.6.11',
  description: 'My CLI tool.'

sumUp(data); //=> '\u001b[36mcli-name\u001b[39m \u001b[90mv0.6.11\u001b[39m\nMy CLI tool.'
sumUp(data, {color: false}); //=> 'cli-name v0.6.11\nMy CLI tool.'


ISC License © 2017 Shinnosuke Watanabe

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free