https://github.com/kevinzma/iconlink
https://github.com/kevinzma/iconlink
cli config folder icon tool
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kevinzma/iconlink
- Owner: KevinZMa
- License: mit
- Created: 2023-03-28T22:59:43.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T23:14:13.000Z (about 2 years ago)
- Last Synced: 2025-03-21T09:39:19.228Z (2 months ago)
- Topics: cli, config, folder, icon, tool
- Language: JavaScript
- Homepage: https://npmjs.org/package/iconlink
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iconlink
A Node.js CLI application that sets custom icons for folders based on a YAML configuration file.
## Requirements
- [Node.js](https://nodejs.org) (version >=12.0.0)
- [fileicon](https://github.com/mklement0/fileicon)
## Installation
### via [`npm`](https://npm.im/iconlink)
```bash
$ npm install -g iconlink
```
### Clone the Repository
```bash
$ git clone https://github.com/KevinZMa/iconlink.git /path/to/iconlink
$ cd /path/to/iconlink
```
## Usage
1. Set up your parent folder in this structure:
```bash
parent_folder/
├── .icons/ # where your icons are stored
│ ├── icon1.icns
│ └── icon2.icns
├── folder1/
├── folder2/
└── icons.yml # configuration file
```
2. In the `icons.yml` file, specify the folder-icon mappings:
```yaml
folder1: icon1.icns
folder2: icon2.icns
```
3. Run the CLI app with the command:
```bash
$ iconlink [--no-confirm]
```