AppCode 2019.3 Help

CocoaPods

AppCode comes with the support for CocoaPods — a dependency manager for Swift and Objective-C projects. In AppCode, you can easily install and update pods and create and edit a Podfile.

Before you start

To be able to work with CocoaPods, you need to specify the path to the Ruby SDK and install the CocoaPods gem.

Specify the Ruby SDK

  1. Select Tools | CocoaPods | Select Ruby SDK from the main menu.
  2. In the Preferences dialog that opens, click Add Ruby SDK, and specify the path to the Ruby SDK that will be used with CocoaPods, by default, /usr/bin/ruby:

    Add Ruby SDK

Install CocoaPods gem

Do one of the following:

  • Click Install CocoaPods in the Preferences dialog.

  • Select Tools | CocoaPods | Install CocoaPods gem from the main menu.

After the CocoaPods gem is installed, the list of pods is displayed on the Tools | CocoaPods page of the Preferences dialog:

List of pods

Install pods

Dependencies used in your project should be listed in a text file named Podfile located in the same directory with the .xcodeproj file.

Create a Podfile

If there is no Podfile in your project, you can create it in AppCode:

  • From the main menu, select Tools | CocoaPods | Create CocoaPods Podfile.

Edit a Podfile

To open the existing Podfile for editing:

  • From the main menu, select Tools | CocoaPods | Edit Podfile.

The Podfile will be opened in the editor. You can use AppCode's code completion and inspections while editing the Podfile.

Install pods

  1. Open the Podfile by selecting Tools | CocoaPods | Edit Podfile from the main menu.

  2. Type the name of the pod(s) that you need to install under the corresponding target(s). For example:
    project 'iOSConferences.xcodeproj' target 'iOSConferences' do use_frameworks! pod 'Yams' end

    Read more about the Podfile syntax here.

  3. After you type the pod name, the The pods are not installed message appears:

    Install pods

    To install the pods, do one of the following:

    • Place the caret at the code line where you add the pod, press ⌥⏎, select Install, and press .

    • Click Install pods in the top-left corner of the editor window.

    • From the main menu, select Tools | CocoaPods | Install.

Podfile coding assistance

While working on a Podfile content, you can take advantage of the following coding assistance features:

  • Syntax highlighting and error detection.

  • Completion of:
    • key functions names (pod, target, podspec, and so on.)

    • pod arguments (names and versions of available pods)

    • target argument (names of available targets)

    • platform arguments (names and versions of available platforms).

  • On-the-fly inspections. AppCode warns you whenever it detects that:
    • pods defined in the Podfile but not installed

    • pods installed but not defined in the Podfile

    • installed version of the pod differs from the version described in the Podfile

    • unknown pods

    • unknown or invalid pod version in the Podfile

    • locally installed pod versions don't match the description in the Manifest.lock file

    • new version of a pod is available.

Last modified: 6 February 2020