osxiconutils

https://github.com/sveinbjornt/osxiconutils
Admin
osxiconutils is a suite of Mac command line utilities to get or set Mac OS X file icons and convert...
Tokens:2,439
Snippets:35
Trust Score:9.7
License:BSD-2-Clause
Update:6 months ago
Show doc for...
Tokens:
Raw
### Build osxiconutils from source

Source: https://context7.com/sveinbjornt/osxiconutils/llms.txt

Compile the utilities using the provided shell script or individual Xcode targets.

```bash
# Build using the shell script (creates bin/ directory with all tools)
./build.sh

# Or build individual targets with xcodebuild
xcodebuild -project osxiconutils.xcodeproj -target "seticon" -configuration Release
xcodebuild -project osxiconutils.xcodeproj -target "geticon" -configuration Release
xcodebuild -project osxiconutils.xcodeproj -target "image2icns" -configuration Release
xcodebuild -project osxiconutils.xcodeproj -target "icns2image" -configuration Release

# Install man pages (optional)
sudo cp *.1 /usr/local/share/man/man1/
```

--------------------------------

### Manipulate icons with IconFamily API

Source: https://context7.com/sveinbjornt/osxiconutils/llms.txt

Use the IconFamily class to create, load, apply, and extract icon data from files and system resources.

```objc
#import "IconFamily.h"

// Create icon family from an image file
NSImage *image = [[NSImage alloc] initWithContentsOfFile:@"logo.png"];
IconFamily *iconFamily = [[IconFamily alloc] initWithThumbnailsOfImage:image];

// Write to icns file
[iconFamily writeToFile:@"output.icns"];

// Set as custom icon for a file
[iconFamily setAsCustomIconForFile:@"/path/to/file.txt"];

// Set as custom icon for a directory
[iconFamily setAsCustomIconForDirectory:@"/path/to/folder"];

// Load existing icns file
IconFamily *existingIcon = [IconFamily iconFamilyWithContentsOfFile:@"existing.icns"];

// Get icon from any file (extracts current icon)
IconFamily *fileIcon = [IconFamily iconFamilyWithIconOfFile:@"/Applications/Safari.app"];

// Get system icon by four-character code
IconFamily *sysIcon = [IconFamily iconFamilyWithSystemIcon:kGenericDocumentIcon];

// Extract NSImage with all representations
NSImage *extractedImage = [iconFamily imageWithAllReps];

// Get specific bitmap representation
NSBitmapImageRep *rep = [iconFamily bitmapImageRepWithAlphaForIconFamilyElement:kIconServices512PixelDataARGB];

// Remove custom icon from file
[IconFamily removeCustomIconFromFile:@"/path/to/file.txt"];

// Remove custom icon from directory
[IconFamily removeCustomIconFromDirectory:@"/path/to/folder"];

// Create icon with custom image interpolation
IconFamily *smoothIcon = [[IconFamily alloc] initWithThumbnailsOfImage:image
                                            usingImageInterpolation:NSImageInterpolationHigh];
```

--------------------------------

### Set Custom File Icons with seticon

Source: https://context7.com/sveinbjornt/osxiconutils/llms.txt

Applies a custom .icns file to one or more files or directories. The tool automatically detects the target type to apply the icon correctly.

```bash
# Set a custom icon for a single file
seticon myicon.icns document.pdf

# Set the same icon for multiple files at once
seticon icon.icns file1.txt file2.txt file3.txt

# Set a custom folder icon
seticon folder_icon.icns ~/Projects/MyApp

# Apply an app icon to multiple directories
seticon app.icns build/ dist/ release/

# Usage syntax
# seticon iconFile [files ...]
```

--------------------------------

### Extract File Icons with geticon

Source: https://context7.com/sveinbjornt/osxiconutils/llms.txt

Retrieves the current icon from a file or directory and saves it as an .icns file.

```bash
# Extract the icon from an application
geticon /Applications/Safari.app safari_icon.icns

# Get the icon from any file type
geticon ~/Documents/report.pdf pdf_icon.icns

# Extract a folder's custom icon
geticon ~/Desktop/MyFolder folder.icns

# Extract system preference pane icon
geticon /System/Library/PreferencePanes/Network.prefPane network.icns

# Usage syntax
# geticon src_file out_icon.icns
```

--------------------------------

### Convert image to icns file

Source: https://github.com/sveinbjornt/osxiconutils/blob/master/image2icns.man.html

Basic usage of the image2icns command to transform a source image into an icon file.

```shell
image2icns image.png out.icns
```

--------------------------------

### Convert Images to ICNS with image2icns

Source: https://context7.com/sveinbjornt/osxiconutils/llms.txt

Converts standard image formats like PNG, JPEG, or TIFF into Apple .icns files, automatically generating required icon sizes.

```bash
# Convert a PNG image to icns format
image2icns logo.png logo.icns

# Convert a JPEG photo to an icon
image2icns photo.jpg photo_icon.icns

# Create an icon from a TIFF file
image2icns artwork.tiff app_icon.icns

# Convert any supported image format
image2icns design.gif design.icns

# Usage syntax
# image2icns source_image output.icns
```

--------------------------------

### Convert ICNS to Images with icns2image

Source: https://context7.com/sveinbjornt/osxiconutils/llms.txt

Converts .icns files to standard image formats, with options to specify output format and extract specific icon sizes.

```bash
# Convert icns to PNG (format detected from extension)
icns2image icon.icns output.png

# Convert to JPEG with explicit format flag
icns2image -t jpeg icon.icns output.jpg

# Convert to TIFF format
icns2image -t tiff icon.icns output.tiff

# Extract specific 512x512 representation
icns2image -r 512 icon.icns icon_512.png

# Extract 128x128 representation as JPEG
icns2image -r 128 -t jpeg icon.icns icon_128.jpg

# Extract 256x256 representation
icns2image -r 256 icon.icns icon_256.png

# Supported formats: png, jpg/jpeg, gif, tiff, bmp
# Available representation sizes: 16, 32, 64, 128, 256, 512, 1024

# Command line options:
# -r, --representation SIZE   Extract specific icon size (e.g., 128, 256, 512)
# -t, --type FORMAT           Output format (jpeg, png, gif, tiff, bmp)
# -v, --version               Print version information
# -h, --help                  Print help message

# Usage syntax
# icns2image [-r size] [-t format] source.icns output_file
```

--------------------------------

### Convert ICNS to JPEG

Source: https://github.com/sveinbjornt/osxiconutils/blob/master/icns2image.man.html

Use this command to convert an ICNS file to a JPEG image. Specify the output format using the -t flag.

```bash
icns2image -t jpeg source.icns source.jpg
```

--------------------------------

### Convert ICNS to TIFF with Specific Size

Source: https://github.com/sveinbjornt/osxiconutils/blob/master/icns2image.man.html

Convert an ICNS file to a TIFF image, specifying a particular representation size (e.g., 512 pixels) using the -r flag.

```bash
icns2image -r 512 icon.icns icon.tiff
```

--------------------------------

### Convert ICNS to PNG

Source: https://github.com/sveinbjornt/osxiconutils/blob/master/icns2image.man.html

Convert an ICNS file to a PNG image. If no specific size or format is given, it defaults to the largest representation and PNG format.

```bash
icns2image icon.icns icon.png
```
Tokens:
Raw