Introduction

What is FolderKit?

FolderKit is a modern, type-safe library designed for the programmatic generation of pixel-perfect macOS folder icons. Engineered with a TypeScript-first approach, it provides full type definitions to ensure a robust and predictable development experience.

The library leverages the high-performance Sharp  image processing library to deliver optimized performance and high-quality output.

Features

FolderKit offers a comprehensive set of features for developers seeking to customize folder icons on macOS:

• 🖼️ Icon Generation: Generate aesthetically pleasing macOS folder icons from any standard image source.
• 🎨 Built-in Themes: Comes with multiple pre-packaged themes, including Big Sur Light/Dark and the classic Tahoe style, enabling consistent and platform-aligned designs.
• 🏗️ Type-Safe: Developed entirely in TypeScript, providing strong type safety and improved developer ergonomics.
• ⚡ Performance-Optimized: Utilizes the sharp library for efficient, high-speed image processing.

FAQ

Does FolderKit have a CLI?

No, FolderKit does not include a CLI.

The primary goal of FolderKit is to provide a modern, programmatic API for developers who need to generate macOS icons within their TypeScript/JavaScript projects.

If you require a command-line tool for generating folder icons, we recommend using the original project that inspired FolderKit: lgarron/folderify . It is an excellent tool specifically designed for CLI usage.