Installation Guide

How to install Nuke in your project

Nuke can be installed using any of the popular package managers.

Swift Package Manager #

Swift Package Manager is a dependency manager built into Xcode.

If you are using Xcode 11 or higher, go to File / Swift Packages / Add Package Dependency… and enter package repository URL https://github.com/kean/Nuke.git, then follow the instructions.

To remove the dependency, select the project and open Swift Packages (which is next to Build Settings). You can add and remove packages from this tab.

Swift Package Manager can also be used from the command line.

CocoaPods #

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate Nuke into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '11.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'Nuke', '~> 9.0'
end

Then, run the following command:

$ pod install

Carthage #

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Nuke into your Xcode project using Carthage, specify it in your Cartfile:

github "kean/Nuke" ~> 9.0

Run carthage update to build the framework and drag the built Nuke.framework into your Xcode project.

Manually #

If you prefer not to use either of the aforementioned dependency managers, you can integrate Nuke into your project manually.

Embedded Framework #

  • Open up Terminal, cd into your top-level project directory, and run the following command “if” your project is not initialized as a git repository:
$ git init
  • Add Nuke as a git submodule by running the following command:
$ git submodule add https://github.com/kean/Nuke.git
  • Open the new Nuke folder, and drag the Nuke.xcodeproj into the Project Navigator of your application’s Xcode project.

It should appear nested underneath your application’s blue project icon. Whether it is above or below all the other Xcode groups does not matter.

  • Select the Nuke.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.
  • Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the “Targets” heading in the sidebar.
  • In the tab bar at the top of that window, open the “General” panel.
  • Click on the + button under the “Embedded Binaries” section.
  • You will see two different Nuke.xcodeproj folders each with two different versions of the Nuke.framework nested inside a Products folder.

It does not matter which Products folder you choose from, but it does matter whether you choose the top or bottom Nuke.framework.

  • Select the top Nuke.framework for iOS and the bottom one for OS X.

The Nuke.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Minimum Requirements #

Nuke Swift Xcode Platforms
Nuke 9.0 Swift 5.1 Xcode 11.0 iOS 11.0 / watchOS 4.0 / macOS 10.13 / tvOS 11.0
Nuke 8.0 Swift 5.0 Xcode 10.2 iOS 10.0 / watchOS 3.0 / macOS 10.12 / tvOS 10.0
Nuke 7.6 Swift 4.2 Xcode 10.1 iOS 10.0 / watchOS 3.0 / macOS 10.12 / tvOS 10.0
Nuke 6.0 Swift 4.0 Xcode 9.2 iOS 9.0 / watchOS 2.0 / macOS 10.10 / tvOS 9.0