🏁Getting Started

mdbadges-cli is an extensive CLI tool to find over 500+ Shields.io badges for your projects without needing to leaving the terminal, featuring multiple commands with different purposes.

To get started, make sure you have at least Node.js 18 installed, then install mdbadges-cli onto your machine by running:

npm install -g mdbadges-cli

---

To start using any of the commands, add the mdb prefix, followed by the command name/syntax. For example, to find a Discord badge, run:

mdb social discord

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

If you are not sure of the available categories, you can visit the table in the repository.

To find what a command does or its syntax while in the terminal, run mdb help to display all commands, their syntax, aliases, and additional options.

Aliases

To view all available aliases for a command, go to the bottom of their documentation, where the aliases (if any) will be displayed, separated by bullet points if there is more than one.

Additional Options

Some commands also have additional options, which are also listed towards the end of each command's documentation (if they have any), separated by a /if there is more than one alias for an option. This is followed by the documentation relating to the specific option.

Want to add your own badges?

Check out the contributing guidelines before you make a pull request, then make a contribution to the repository!

Note that badges which are added to the parent repository (md-badges) are manually added to mdbadges-cli after a couple of days/weeks.