mdbadges-cli is an extensive CLI tool to find over 400+ Shields.io badges for your projects without needing to leaving the terminal, with multiple commands for different purposes.
npm install -g mdbadges-cli
To start using a command, add the mdb prefix, followed by the command name/syntax.
For example:
mdb social discord
# Badge found:
# [](#)If you want to use a prefix, such as --style, you can run the same command with the prefix after it.
For example:
mdb social discord --style plastic
# Badge found:
# [](#)[!TIP] If you are running mdbadges-cli in Visual Studio Code, try installing the Image Preview extension. You can hover over the badge link to see a preview of it. See an example here.
For help information, such as what commands do and/or accept, run mdb help in the terminal. Alternatively, you can read the documentation.
| Command | Description | Aliases | Additional Information |
|---|---|---|---|
mdb [category] [badgeName] |
Displays badge from a specific category. | N/A | View all available options on the documentation. |
mdb search |
Displays badges available in a category. |
s, find
|
Badges are listed in the format you need to fill the [badgeName] field out in. |
mdb lookup [keyword] |
Displays badges containing a certain keyword. | l |
Clicking Enter on a badge will give you the badge code. |
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 (eg. 000, #d8e, #FAF126) are supported. |
mdb random |
Displays a random badge. | r |
Supports both Markdown and HTML formats. |
mdb copy [category] [badgeName] |
Copies a badges' code to the clipboard. | c |
Only supports copying Markdown version. |
mdb badges |
Opens a link to the badge list in your browser. | list |
N/A |
mdb add [category] [badgeName] [fileName] |
Allows you to add a badge to a Markdown file. | N/A | Only supports Markdown versions of badges. Works in subdirectories, as long as the file path is correct. |
| Command | Description | Aliases | Additional Information |
|---|---|---|---|
mdb about |
Displays general information about the package. | abt |
Also shows links to various important places and information like the current amount of badges. |
mdb documentation |
Opens a link to the documentation in your browser. | docs |
N/A |
mdb changelog |
Opens a link to the latest release with it's changelogs in your browser. | release |
N/A |
This contains the categories that are currently available, with the names and syntax. The syntax is needed for the [category] field of certain commands.
| Name | Syntax |
|---|---|
| App Store | app-store |
| Artificial Intelligence | ai |
| Blog | blog |
| Browser | browser |
| Code Coverage | code-coverage |
| Code Editor | code-editor |
| Cloud | cloud |
| Collaboration | collaboration |
| Crypto | crypto |
| Database | database |
| Design | design |
| Delivery | delivery |
| Documentation | documentation |
| Education | education |
| Funding | funding |
| Framework | framework |
| Game Engine | game-engine |
| Gaming Storefront | game-stores |
| Jobs | jobs |
| Office | office |
| Operating System | os |
| Package Manager | package-manager |
| Payment | payment |
| Programming Language | programming |
| Restaurant | restaurant |
| Review | review |
| Search Engine | search-engine |
| Social Media | social |
| Sound | sound |
| Static Site | static-site |
| Storage | storage |
| Video Streaming | video-streaming |
| Virtual Reality | vr |
If you would like to contribute, please ensure to read the contributing guidelines before you submit a pull request.
© 2024 · Licensed under the MIT License