https://github.com/dkchiem/make-icns
A CLI to help you convert a single PNG file into an ICNS file.
https://github.com/dkchiem/make-icns
cli convert converter generator icns icon image png
Last synced: 9 months ago
JSON representation
A CLI to help you convert a single PNG file into an ICNS file.
- Host: GitHub
- URL: https://github.com/dkchiem/make-icns
- Owner: dkchiem
- License: mit
- Created: 2020-05-10T23:53:45.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T03:08:31.000Z (about 3 years ago)
- Last Synced: 2025-03-20T11:48:24.997Z (over 1 year ago)
- Topics: cli, convert, converter, generator, icns, icon, image, png
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/make-icns
- Size: 972 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# make-icns
[](https://www.npmjs.com/package/make-icns) [](https://github.com/electron-userland/electron-forge/blob/master/LICENSE) [](https://david-dm.org/dkchiem/make-icns.svg)
**make-icns** is a CLI that converts a single PNG image into a ICNS image. It does this very quickly with very good quality! This CLI is designed to be simple to use on your local machine and to implement in other projects.
## Installation
> You may need to use `sudo` to install the package globally. If you get an error installing with sudo, you can try to add`--unsafe-perm` to the command. This CLI has been tested on _macOS Ventura_ and _Ubuntu 18.04 (LTS)_.
```bash
$ npm i -g make-icns
```
After installing the cli globally or on your project, you are ready to use it.
## Usage
> In order to get a good quality icon, it is highly recommended that the picture be at least 1024x1024 pixels.
This command will convert your PNG into an ICNS in the destination directory. The generated ICNS file will by default take the name of the PNG file. Note that the new image will also override any ICNS file with the same name and extension in the destination directory.
Command:
```bash
$ mk-icns
```
Options:
| Options | Desription | Type |
| ---------------- | :-----------------------------: | -----: |
| -n | Name of the generated ICNS file | string |
| -h, --help, help | Show help | - |
Example:
```bash
$ mk-icns /path/to/pngFile.png /destination/directory -n "This_Is_An_ICNS_File"
```
## Author
- **Dang Khoa Chiem** - dkchiem
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details