Getting Started

This guide provides the necessary steps to install and integrate FolderKit into your project.

Before you begin, ensure you have the following set up:

Node.js Environment: FolderKit is a Node.js library, so you must have Node.js installed. The library requires Node.js version ^20.

FolderKit is distributed as a package on the npm registry. It can be installed in your project using any Node.js package manager.

To add FolderKit to your project’s dependencies, execute the following command:


npm install folderkit


pnpm add folderkit


yarn add folderkit


bun add folderkit

Once the installation is complete, you can begin using the library by importing its functions into your project files.

Congratulations! You have successfully generated your icon files, the final step is to apply them to your folders on macOS.

For a detailed walkthrough, please see the guide on How to Apply Your Custom Icons on macOS.