alvarowolfx / iconik

CLI tool for generating icons for iOS and Android apps.

iconik - App Icon Generator

CLI tool for generating icons for iOS and Android apps.

The goal of the project is to generate the icons necessary, detect the project architeture (Native, React Native, Flutter, Cordova, etc) and setup all the icons accordingly.

Goals

• Generate icons in all needed sizes.
• Publish as NPM package.
• Detect project architecture.
• Setup icons files accordingly to the project architecture.
• Add option to zip all icons.

Install

npm install -g iconik

Usage

Generate app icons in all different sizes.

USAGE
  $ iconik ICON

ARGUMENTS
  ICON  input icon

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: icons] output folder
  -v, --version        show CLI version
  --android            generate android icons
  --ios                generate ios icons

DESCRIPTION
  Generate app icons in all different sizes.
  Please provide an icon with at least 512x512px.

Example Output

$ iconik icon.png
  ✔ Check Input
  ✔ Image Check
  ✔ Check output
  ✔ Generate icons

$ ls icons
hdpi.png                       [email protected]      [email protected]     playStore.png
[email protected]               [email protected]             [email protected]     xhdpi.png
[email protected]   [email protected]             [email protected]    xxhdpi.png
[email protected]        [email protected] [email protected]    xxxhdpi.png
[email protected]       [email protected] mdpi.png

Running locally

$ ./bin/run ICON

Credits

• sharp - Blazing fast image resize module.
• ocli - Awesome CLI Framework.

iconik's Issues

Detect project architecture.

Detect project structure to see if is a native, React Native, Cordova or Flutter app and put data on context to be used by other tasks.

Script obliterates existing files in output directory

First and foremost thank you for writing and open sourcing this, but an issue and warning to others:

This script DELETES ALL FILES and folders in the output directory!!!

I stupidly decided to test it by pointing it at one of my directories and it obliterated everything. Be careful and hopefully this behavior can be patched in a future version!

Add tests to the project

And later setup a CI workflow.