othyn / github-folder-icon-macOS

GitHub folder icon for use in macOS. Made so that it fits nicely alongside all the others inside your home directory. Mac OS X 10.5 (Leopard) through to macOS 13 (Ventura).

🍏📁 macOS GitHub Folder Icon

Made so that it fits nicely alongside all the others inside your home directory... or wherever.

What do we have here...

• ... 📈 A version available all the way from Mac OS X 10.5 (Leopard) through to macOS 13 (Ventura)
• ... 🌗 Light and Dark mode variants (where applicable, macOS 11 or later)
• ... 📁 Both icns and iconset versions of all icons
• ... 🖼️ All icon sizes from 16x16 through to 512x512@2x

   

👇 Downloading & using the icon(s)

🐌 The manual way

The easiest way will be for you to download the icon you want from the the icons directory. Simply find which macOS version you would like the icon for, and if applicable the light or dark mode variant, and download the icns file within that directory using GitHub's Download button once within a file's context:

To apply the icon, right click on the directory that you wish to update the icon of and click 'Get Info', a new dialogue window should appear. You now need to click-and-drag the downloaded icns file into the small icon in the top left of the window next to the directory name:

Ta-da! 🎉 You're all set, the icon should now be looking glorious.

🚀 The fun way

There's a brilliant tool called fileicon in which can programmatically set the icons of files and folders in macOS.

To install it via brew:

brew install fileicon

Then, if we assume that the directory we want to set the icon for is ~/git and the downloaded icon resides in ~/Downloads/icon.icns:

# Assign the custom downloaded GitHub icon to ~/git
fileicon set ~/git ~/Downloads/icon.icns

Ta-da! 🎉 You're all set, the icon should now be looking glorious.

To restore the icon to its original state:

# Remove the custom downloaded GitHub icon from ~/git
fileicon rm ~/git

More examples can be found under the Examples heading in the fileicon README.

🧰 Installing dependencies

I used to manually find and extract the folder icon upon every release, but someone recently introduced me to... folderify! Which has made maintaining this repo a breeze.

Make sure brew is installed (don't want to automate installing this on your system) and then go ahead and run the make command to get things setup:

make install

🏗️ Generating icons

This is as simple as ensuring that you've already run make install and then running:

make icons

🎨️ Manually generating just the icons

To generate just the icons on their own, run:

make generate

Although this step is run prior to generating new icons anyway.

🖼️ Manually generating a new preview image

To generate a new preview image, used in the README of this project, run:

make preview

Although this step is run prior to generating new icons anyway.

🗑️ Manually cleaning Icons

If you want to quickly wipe the slate clean, run:

make clean

Although this step is run prior to generating new icons anyway.

❓ F.A.Q's

• Can I get the icon to automatically change with light/dark mode?

  • Unfortunately, no. As mentioned in the Folderify README, under Usage:

    There is currently no simple way to set an icon that will automatically switch between light and dark when you switch the entire OS. You can only assign one icon to a folder.

  • This appears to be a limitation within macOS itself and Apple currently not allowing for the distinction between two icons

🎂 Sources

• Amazing GitHub icon: Dave Gandy on flaticon
• Superb icon generation: folderify
• Brilliant icon application automation: fileicon
• Fabulous macOS package manager: brew