mdbadges-cli is an extensive CLI tool to find over 400+ Shields.io badges for your projects without needing to leave the terminal, featuring multiple commands with different purposes.
To globally install mdbadges-cli onto your machine, you can run the following:
npm install -g mdbadges-cli
To start using a command, add the mdb prefix, followed by the correct command name and syntax. For example:
mdb social discord
# Badge found:
# [](#)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:
# [](#)Tip
If you are using Visual Studio Code, you should install the Image Preview extension. Hovering over the badge link will allow you to see a preview of it. See an example here.
For help information, such as what commands do or what arguments they accept, run mdb help.
This section contains the commands that are currently available, with their corrosponding syntax, arguements, and aliases.
| Command | Description | Aliases | Additional Information |
|---|---|---|---|
mdb [category] [badgeName] |
Displays badge from a specific category. | None | View all available options on the documentation. |
mdb search |
Search for badges across any 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 |
Supports copying Markdown version, and HTML version via --html. |
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 | Supports both Markdown versions of badges, and HTML versions using --html. Also works in subdirectories. |
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. |
This section contains the categories that are currently available, with their corresponding 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 |
| CI | ci |
| Cloud | cloud |
| Code Coverage | code-coverage |
| Code Editor | code-editor |
| Collaboration | collaboration |
| Cryptocurrency | crypto |
| Database | database |
| 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 |
| 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 |
To learn more about mdbadges-cli and how to use certain commands/options, visit the documentation.
If you would like to contribute, please ensure to read the contributing guidelines before you submit a pull request.
© 2024 · mdbadges-cli is licensed under the MIT License.
