> For the complete documentation index, see [llms.txt](https://inttter.gitbook.io/mdbcli/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://inttter.gitbook.io/mdbcli/start/getting-started.md).

# 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](https://nodejs.org/en/blog/release/v18.0.0) installed, then install mdbadges-cli onto your machine by running:

```sh
npm install -g mdbadges-cli
```

[<img src="https://github.com/inttter/mdbadges-cli/actions/workflows/publish.yml/badge.svg?event=release" alt="Release to NPM" data-size="original">](https://github.com/inttter/mdbadges-cli/actions/workflows/publish.yml) [<img src="https://github.com/inttter/mdbadges-cli/actions/workflows/test.yml/badge.svg" alt="Tests" data-size="original">](https://github.com/inttter/mdbadges-cli/actions/workflows/test.yml)

***

To start using any of the commands, add the `mdb` prefix, followed by the [**command name/syntax**](https://github.com/inttter/mdbadges-cli/tree/main#commands). For example, to find a Discord badge, run:

<pre class="language-sh"><code class="lang-sh"><a data-footnote-ref href="#user-content-fn-1">mdb</a> <a data-footnote-ref href="#user-content-fn-2">social</a> <a data-footnote-ref href="#user-content-fn-3">discord</a>

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

If you are not sure of the available categories, you can [visit the table in the repository](https://github.com/inttter/mdbadges-cli?tab=readme-ov-file#categories).

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](https://github.com/inttter/mdbadges-cli/blob/main/CONTRIBUTING.md) 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](https://github.com/inttter/md-badges)) are manually added to mdbadges-cli after a couple of days/weeks.

[^1]: The **prefix**.

[^2]: The **category** name.

[^3]: The **badge** name.