{"id":26882599,"url":"https://github.com/inttter/mdbadges-cli","last_synced_at":"2025-09-15T18:47:01.495Z","repository":{"id":215329291,"uuid":"738305791","full_name":"inttter/mdbadges-cli","owner":"inttter","description":"An extensive CLI tool to find over 500+ Shields.io badges for your projects.","archived":false,"fork":false,"pushed_at":"2025-03-30T13:31:45.000Z","size":3693,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-30T13:34:36.583Z","etag":null,"topics":["badge","badges","cli","markdown","md-badges","mdbadges","profile","shields","shieldsio","social"],"latest_commit_sha":null,"homepage":"https://inttter.gitbook.io/mdbcli","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inttter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"intter","github":"inttter"}},"created_at":"2024-01-02T23:28:50.000Z","updated_at":"2025-03-30T13:31:48.000Z","dependencies_parsed_at":"2024-06-16T18:22:59.970Z","dependency_job_id":"07cdbd4e-cd45-479f-85f6-1036ae78f0e6","html_url":"https://github.com/inttter/mdbadges-cli","commit_stats":null,"previous_names":["inttter/mdbadges-cli"],"tags_count":84,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inttter%2Fmdbadges-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inttter%2Fmdbadges-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inttter%2Fmdbadges-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inttter%2Fmdbadges-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inttter","download_url":"https://codeload.github.com/inttter/mdbadges-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252989656,"owners_count":21836662,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["badge","badges","cli","markdown","md-badges","mdbadges","profile","shields","shieldsio","social"],"created_at":"2025-03-31T16:39:16.207Z","updated_at":"2025-09-15T18:47:01.483Z","avatar_url":"https://github.com/inttter.png","language":"JavaScript","funding_links":["https://ko-fi.com/intter","https://github.com/sponsors/inttter"],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://github.com/user-attachments/assets/14dd0cdc-6b1b-45ce-8e00-dbd7474866c7\" width=\"150\"\u003e\r\n\r\n# mdbadges-cli\r\n\r\n[![GitHub Release](https://img.shields.io/github/v/release/inttter/mdbadges-cli?style=flat\u0026colorA=18181B\u0026colorB=6134EB\u0026logo=github)](https://github.com/inttter/mdbadges-cli/releases/latest)\r\n[![NPM Downloads](https://img.shields.io/npm/dw/mdbadges-cli.svg?style=flat\u0026colorA=18181B\u0026colorB=6134EB\u0026logo=npm)](https://www.npmjs.com/package/mdbadges-cli/)\r\n[![License](https://custom-icon-badges.herokuapp.com/github/license/inttter/mdbadges-cli?logo=law\u0026color=6134EB\u0026labelColor=191724)](LICENSE)\r\n\r\n**mdbadges-cli** is an extensive command-line tool that lets you search for over **500+** Shields.io badges for your projects without needing to leave the terminal, also including multiple commands with different purposes.\r\n\r\n## Installation\r\n\r\nTo globally install mdbadges-cli, run the following:\r\n\r\n```bash\r\nnpm install -g mdbadges-cli\r\n```\r\n\r\n[![Release](https://github.com/inttter/mdbadges-cli/actions/workflows/publish.yml/badge.svg)](https://github.com/inttter/mdbadges-cli/actions/workflows/publish.yml)\r\n[![CI](https://github.com/inttter/mdbadges-cli/actions/workflows/test.yml/badge.svg)](https://github.com/inttter/mdbadges-cli/actions/workflows/test.yml)\r\n\r\n## Getting Started\r\n\r\nTo start using a command, add the `mdb` prefix, followed by the correct [command name and syntax](#commands). For example:\r\n\r\n```bash\r\nmdb social discord\r\n\r\n# Badge found:\r\n# [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?\u0026logo=discord\u0026logoColor=white)](#)\r\n```\r\n\r\nIf you want to use a option, such as `--style`, you can run the same command with the option placed after it. For example:\r\n\r\n```bash\r\nmdb social discord --style plastic\r\n\r\n# Badge found:\r\n# [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?\u0026logo=discord\u0026logoColor=white\u0026style=plastic)](#)\r\n```\r\n\r\nFor information on things like command syntax or accepted arguments, run `mdb help`.\r\n\r\n## Commands\r\n\r\nThis section contains the commands that are currently available, with their corresponding syntax, arguments, and aliases.\r\n\r\n|   Command                                 |    Description    |     Aliases      | Additional Information |\r\n|-------------------------------------------|-------------------|------------------|------------------------|\r\n`mdb [category] [badgeName]`                | Displays badge from a specific category. | None | Supports changing style using [`--style`](https://inttter.gitbook.io/mdbcli/commands/finding-a-badge#style-s), adding a link to the badge using [`--link`](https://inttter.gitbook.io/mdbcli/commands/finding-a-badge#style-s), and HTML using the `--html` option. Also supports finding [multiple badges](https://inttter.gitbook.io/mdbcli/commands/finding-a-badge#auto-update) at once.\r\n`mdb search`                                | Searches for badges across any [category](#categories). | `s`, `find`, `lookup` | Select a badge to get the Markdown code for it. Loops until `No` is selected.\r\n`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.\r\n`mdb add [category] [badgeName] [filePath]` | Allows you to add a badge to a file. | None | This works with [subdirectories](https://inttter.gitbook.io/mdbcli/commands/add#adding-badges-to-subdirectories) too. Also supports adding HTML versions using the `--html` option.\r\n`mdb copy [category] [badgeName]`           | Copies a badges' code to the clipboard. | `c` | Also supports copying HTML versions using the `--html` option.\r\n`mdb random`                                | Displays a random badge. | `r` | Displays the badge in both Markdown and HTML formats.\r\n`mdb badges`                                | Opens a link to the badge list in your browser. | `list` | Opens in your default browser.\r\n`mdb docs` | Opens a link to the documentation in your browser. | None | Opens in your default browser.\r\n`mdb changelog` | Opens a link to the latest release and it's changelog in your browser. | `release` | Opens in your default browser.\r\n\r\n## Categories\r\n\r\nThis 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.\r\n\r\n| Name                    | Syntax                 |\r\n|-------------------------|------------------------|\r\n| API Development         | `api-dev`              |\r\n| App Store               | `app-store`            |\r\n| Artificial Intelligence | `ai`                   |\r\n| Blog                    | `blog`                 |\r\n| Browser                 | `browser`              |\r\n| CI                      | `ci`                   |\r\n| Cloud                   | `cloud`                |\r\n| Code Coverage           | `code-coverage`        |\r\n| Code Editor             | `code-editor`          |\r\n| Collaboration           | `collaboration`        |\r\n| Cryptocurrency          | `crypto`               |\r\n| Database                | `database`             |\r\n| Data Science            | `data-science`         |\r\n| Delivery                | `delivery`             |\r\n| Design                  | `design`               |\r\n| Documentation           | `documentation`        |\r\n| Education               | `education`            |\r\n| Funding                 | `funding`              |\r\n| Framework               | `framework`            |\r\n| Game Engine             | `game-engine`          |\r\n| Gaming Storefront       | `game-store`           |\r\n| Jobs                    | `jobs`                 |\r\n| Operating System        | `os`                   |\r\n| ORM                     | `orm`                  |\r\n| Package Manager         | `package-manager`      |\r\n| Payment                 | `payment`              |\r\n| Programming Language    | `programming`          |\r\n| Review                  | `review`               |\r\n| Search Engine           | `search-engine`        |\r\n| Social Media            | `social`               |\r\n| Sound                   | `sound`                |\r\n| Static Site             | `static-site`          |\r\n| Storage                 | `storage`              |\r\n| Streaming               | `streaming`            |\r\n| Terminal                | `terminal`             |\r\n| Version Control         | `version-control`      |\r\n| Virtual Reality         | `vr`                   |\r\n\r\n## Documentation\r\n\r\nTo learn more about mdbadges-cli and how to use certain commands, along with their options, visit the [documentation](https://inttter.gitbook.io/mdbcli), which hosts more detailed information and various examples.\r\n\r\n## Contributing\r\n\r\nIf you would like to contribute in any way, such as adding a badge, please make sure to read the [contributing guidelines](CONTRIBUTING.md) first before making a contribution.\r\n\r\n## License \r\n\r\n© **2025** - mdbadges-cli is licensed under the [MIT License](LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finttter%2Fmdbadges-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finttter%2Fmdbadges-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finttter%2Fmdbadges-cli/lists"}