https://github.com/badgen/badgen-cli

Use the fastest badge generator from your CLI
https://github.com/badgen/badgen-cli

cli generator icon svg

Last synced: 5 days ago
JSON representation

Use the fastest badge generator from your CLI

• Host: GitHub
• URL: https://github.com/badgen/badgen-cli
• Owner: badgen
• License: mit
• Created: 2019-05-02T08:26:53.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-15T10:57:10.000Z (over 1 year ago)
• Last Synced: 2024-05-02T01:25:53.116Z (6 months ago)
• Topics: cli, generator, icon, svg
• Language: JavaScript
• Homepage:
• Size: 338 KB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# badgen-cli

[![npm version][npm-src]][npm-href]

[![Install size][packagephobia-src]][packagephobia-href]

[![License][license-src]][license-href]

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](https://github.com/badgen/badgen), the module behind this CLI.

[npm-src]: https://badgen.net/npm/v/badgen-cli

[npm-href]: https://www.npmjs.com/package/badgen-cli

[packagephobia-src]: https://badgen.net/packagephobia/install/badgen-cli

[packagephobia-href]: https://packagephobia.now.sh/result?p=badgen-cli

[license-src]: https://badgen.net/github/license/badgen/badgen-cli

[license-href]: LICENSE