Automatically add a badge to your app icon

Please use the badge plugin instead.
This action will add a light/dark badge onto your app icon.
You can also provide your custom badge/overlay or add a shield for more customization.
More info:
Note: If you want to reset the badge back to default, you can use sh 'git checkout -- <path>/Assets.xcassets/'.

Supported platforms ios, android, mac
Author @DanielGri

4 Examples

badge(dark: true)
badge(alpha: true)
badge(custom: "/Users/xxx/Desktop/badge.png")
badge(shield: "Version-0.0.3-blue", no_badge: true)


Key Description Default
dark Adds a dark flavored badge on top of your icon
custom Add your custom overlay/badge image
no_badge Hides the beta badge
shield Add a shield to your app icon from
alpha Adds and alpha badge instead of the default beta one
path Sets the root path to look for AppIcons .
shield_io_timeout Set custom duration for the timeout of the request in seconds
glob Glob pattern for finding image files
alpha_channel Keeps/adds an alpha channel to the icon (useful for android icons)
shield_gravity Position of shield on icon. Default: North - Choices include: NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast
shield_no_resize Shield image will no longer be resized to aspect fill the full icon. Instead it will only be shrunk to not exceed the icon graphic

* = default value is dependent on the user's system


To show the documentation in your terminal, run

fastlane action badge


It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run badge

To pass parameters, make use of the : symbol, for example

fastlane run badge parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.

Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub

Back to actions