Mdbadges-cli NPM

mdbadges-cli

mdbadges-cli is an extensive command-line tool that lets you search for over 400+ Shields.io badges for your projects without needing to leave the terminal, also including multiple commands with different purposes.

Installation

To globally install mdbadges-cli, run the following:

npm install -g mdbadges-cli

Getting Started

To start using a command, add the mdb prefix, followed by the correct command name and syntax. For example:

mdb social discord

# Badge found:
# [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?&logo=discord&logoColor=white)](#)

If you want to use a option, such as --style, you can run the same command with the option placed after it. For example:

mdb social discord --style plastic

# Badge found:
# [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?&logo=discord&logoColor=white&style=plastic)](#)

For information on things like command syntax or accepted arguments, run mdb help.

Commands

This section contains the commands that are currently available, with their corresponding syntax, arguments, and aliases.

Command	Description	Aliases	Additional Information
`mdb [category] [badgeName]`	Displays badge from a specific category.	None	Supports changing style using `--style` and adding a link to the badge using `--link`. Also supports HTML using the `--html` option.
`mdb search`	Searches for badges across every category.	`s`, `find`, `lookup`	Select a badge to get the Markdown code for it.
`mdb create`	Displays prompts to create your own badge.	`generate`	Both Markdown and HTML versions of your badge are given. For logo colors, only hexadecimal colors are supported.
`mdb random`	Displays a random badge.	`r`	Displays the badge in both Markdown and HTML formats.
`mdb copy [category] [badgeName]`	Copies a badges' code to the clipboard.	`c`	Also supports HTML versions using the `--html` option.
`mdb badges`	Opens a link to the badge list in your browser.	`list`	Opens in your default browser.
`mdb add [category] [badgeName] [fileName]`	Allows you to add a badge to a Markdown file.	None	This works with subdirectories too. Also supports HTML versions using the `--html` option.
`mdb docs`	Opens a link to the documentation in your browser.	None	Opens in your default browser.
`mdb changelog`	Opens a link to the latest release with it's changelogs in your browser.	`release`	Opens in your default browser.

Name	Syntax
App Store	`app-store`
Artificial Intelligence	`ai`
Blog	`blog`
Browser	`browser`
CI	`ci`
Cloud	`cloud`
Code Coverage	`code-coverage`
Code Editor	`code-editor`
Collaboration	`collaboration`
Cryptocurrency	`crypto`
Database	`database`
Data Science	`data-science`
Design	`design`
Delivery	`delivery`
Documentation	`documentation`
Education	`education`
Funding	`funding`
Framework	`framework`
Game Engine	`game-engine`
Gaming Storefront	`game-store`
Jobs	`jobs`
Operating System	`os`
ORM	`orm`
Package Manager	`package-manager`
Payment	`payment`
Programming Language	`programming`
Review	`review`
Search Engine	`search-engine`
Social Media	`social`
Sound	`sound`
Static Site	`static-site`
Storage	`storage`
Streaming	`streaming`
Terminal	`terminal`
Version Control	`version-control`
Virtual Reality	`vr`

Documentation

To learn more about mdbadges-cli and how to use certain commands/options, visit the documentation, which hosts more detailed information and various examples.