mdbadges-cli

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.

Installation

npm install -g mdbadges-cli

Getting Started

To start using a command, add the mdb prefix, followed by the command name/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)](#)

Tip

If you are using Visual Studio Code, install 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 or what arguments they accept, run mdb help. Alternatively, you can read the documentation.

Commands

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	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 (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.
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

Categories

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
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

Contributing

If you would like to contribute, please ensure to read the contributing guidelines before you submit a pull request.

License

© 2024 · Licensed under the MIT License.