Search packages, repositories and app categories

Package detailsv0.0.2

cli_badges

Print badges to the terminal. Yup, those nifty little thingies we use on readmes, but for CLI apps.

AndroidiOSWebmacOSWindowsLinux
30-day downloads
38.1K
Likes
10
Pub points
130

Install package

flutter pub add cli_badges

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A Dart package that enables CLI applications to print colorful, stylish badges directly in the terminal—similar to those seen in README files. It’s ideal for enhancing command-line output with visual indicators like status, version, or build information. The package supports multiple platforms and integrates seamlessly into Flutter and Dart CLI tools. With minimal setup, developers can add professional-looking badges to console logs, improving readability and user experience in terminal-based workflows.

Use cases

  • Enhancing CLI output with visual status indicators
  • Displaying version and build info in terminals
  • Improving log readability in developer tools
  • Adding branded badges to command-line apps
  • Creating interactive CLI dashboards

Key features

  • Terminal badge rendering
  • Cross-platform support
  • Simple API for badge creation
  • Colorful and customizable badges
  • Lightweight and easy to integrate

Suitable for

  • CLI tool developers
  • DevOps and automation scripts
  • Flutter CLI extensions
  • Developer experience (DX) enhancements
  • Command-line application maintainers

Considerations

  • Limited to terminal output only
  • No support for non-text environments
  • Depends on terminal color capabilities
  • May not render consistently across all terminal types
  • Best suited for modern, ANSI-capable terminals

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Quirky little dart library for generating badges for your cli apps.

Pub Version


Print badges to the terminal. Yup, those nifty little thingies we use on readmes, but for CLI apps.

Features

  • Easy to use
  • Inbuilt themes
  • Customizable

This is what it can do:

var failedBadge  = Badge(label: 'failed', message: '2', theme: BadgeTheme.red);
var successBadge = Badge(label: 'success', message: '2').green();
var skippedBadge = Badge.yellow(label: 'skipped',  message: '2');

print(
    Badge.inline([
        failedBadge, 
        skippedBadge, 
        successBadge
    ]),
);

The above would output something similar to the terminal:

Usage

Usage is simple, import the package and start creating Badges!

import 'package:cli_badges/cli_badges.dart';

var failedBadge = Badge(label: 'failed', message: '2', theme: BadgeTheme.red);

print(failedBadge);
Some more examples:

You could create a donate badge:

var donateBadge = Badge.cyan(label: '❤️ donate', message: 'please?');

print(donateBadge);

You can also only show the label:

var onlyLabel = Badge(
    label: '❤️ donate', 
    labelColorCode: 169
);

print(onlyLabel);
Example output is a mock, console output will vary slightly from terminal to terminal.

Badge Structure

A badge is conformed of a label and a message <label>:<message>. Each segment can be customized, by changing bg color, text color and style.

Themes

Themes are a way to store badge configuration for repeated use.

blue theme-blue cyan theme-cyan
green theme-green magenta theme-magenta
red theme-red yellow theme-yellow

You can also swap all themes, this means properties from label will be applied to message and vice versa.

Inbuilt themes
  • red : Red Message Background
  • green : Green Message Background
  • blue : Blue Message Background
  • yellow : Black Colored Message on yellow Background
  • cyan : Black Colored Message on cyan Background
  • magenta : Black Colored Message on magenta Background
  • success : ('Success') Message on green Background
  • failed : ('Failed') Message on red Background
  • warning : ('Failed') Message on yellow Background
  • info : ('Info') Message on blue Background
Colors

This is the list of all available colors:

  • red
  • black
  • green
  • yellow
  • blue
  • magenta
  • cyan
  • white
  • brightRed
  • brightBlack
  • brightGreen
  • brightYellow
  • brightBlue
  • brightMagenta
  • brightCyan
  • brightWhite
Using themes

There are 3 main ways to create a themed badge:

1 - Passing in the theme directly to the Badge constructor:
Badge(
    label: 'failed', 
    message: '2', 
    theme: BadgeTheme.red,
);
2 - Using named constructors:
Badge.red(
    label: 'failed', 
    message: '2', 
);
3 - Or by calling the predefined theme methods:
Badge(...).red();

Additional info

There is a complete example here

If you encounter any problems or fancy a feature to be added please head over to the GitHub repository and drop an issue.

Want badges for some other environment or language?

cli-badges is also available in other languages:

Support the project

I tend to open source anything I can, and love to help people that might need help with the project.

However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are few ways you can do so:

  • Starring and sharing the project 🚀
  • Reporting bugs 🐛
  • Sending feedback
  • Or even coding :P

Thanks! ❤️

Categories

Source repository

Projects using this package

No data available yet.