badgen-cli

[![npm version][npm-src]][npm-href] [![Install size][packagephobia-src]][packagephobia-href] [![License][license-src]][license-href]


Keywords
cli, badge, svg, generator, icon
License
MIT
Install
npm install badgen-cli@0.2.0

Documentation

badgen-cli

npm version Install size License

Use the fastest badge generator from your CLI.

Installation

$ npm install -g badgen-cli

Usage

$ badgen --subject build --status ok --color green > build-ok.svg

Options

  • --status, -s
    String, right-hand side of the badge (required)
  • --subject, -j
    String, left-hand side of the badge
  • --color, -c
    String, color for the status (color name or RGB hexa value)
  • --flat, -f
    Boolean, use the flat style badge
  • --icon, -i
    String, icon before the subject (icon name, image data URI or inferred from the subject)
  • --icon-width, -w
    Number, width of the icon if not square

See also

  • badgen, the module behind this CLI.