CocoaPods

https://guides.cocoapods.org
Admin
CocoaPods is a dependency manager for Xcode projects that manages library dependencies and resolves...
Tokens:65,861
Snippets:825
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### install! method from Installer class

Source: https://guides.cocoapods.org/contributing/contribute-to-cocoapods.html

Example of a small method that delegates to other methods. It shows the preferred style of keeping methods small and readable.

```ruby
def install!
  resolve_dependencies
  download_dependencies
  generate_pods_project
  integrate_user_project if config.integrate_targets?
  perform_post_install_actions
end

```

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

### install! with custom CocoaPods installation options

Source: https://guides.cocoapods.org/syntax/podfile.html

Specifies the installation method and options for the Podfile. The first parameter must be 'cocoapods'. This example sets :deterministic_uuids and :integrate_targets to false.

```ruby
install! 'cocoapods',
         :deterministic_uuids => false,
         :integrate_targets => false

```

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

### Set up CocoaPods environment with pod setup

Source: https://guides.cocoapods.org/terminal/commands.html

Initializes the CocoaPods environment. Run this command after installing CocoaPods to prepare it for use.

```shell
pod setup 
```

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

### Basic CocoaPods workflow: create Podfile, edit, and install

Source: https://guides.cocoapods.org/terminal/commands.html

Creates a Podfile, opens it for editing, and installs the dependencies specified in it.

```shell
$ touch Podfile
$ vim Podfile
$ pod install
```

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

### Specify plugins with plugin

Source: https://guides.cocoapods.org/syntax/podfile.html

Use the plugin method to specify plugins for installation, along with optional options. The example shows using 'cocoapods-keys' with a keyring option and 'slather'.

```ruby
plugin 'cocoapods-keys', :keyring => 'Eidolon'
plugin 'slather'

```

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

### Checkout feature branch and install dependencies

Source: https://guides.cocoapods.org/using/unreleased-features.html

After cloning, navigate into the repository, check out the desired branch (e.g., 'swift'), and run 'bundle install' to set up the dependencies.

```bash
cd CocoaPods
git checkout swift
bundle install

```

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

### YARD documentation example from Project class

Source: https://guides.cocoapods.org/contributing/contribute-to-cocoapods.html

Example of YARD documentation for a method, showing how to document parameters, return values, notes, and examples.

```ruby
# @return [Pathname] Returns the relative path from the project root.
#
# @param  [Pathname] path
#         The path that needs to be converted to the relative format.
#
# @note   If the two absolute paths don't share the same root directory an
#         extra `../` is added to the result of
#         {Pathname#relative_path_from}.
#
# @example
#
#   path = Pathname.new('/Users/dir')
#   @sandbox.root #=> Pathname('/tmp/CocoaPods/Lint/Pods')
#
#   @sandbox.relativize(path) #=> '../../../../Users/dir'
#   @sandbox.relativize(path) #=> '../../../../../Users/dir'
#

```

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

### Get full path to pod binary

Source: https://guides.cocoapods.org/using/unreleased-features.html

Prints the full path to the 'pod' binary inside the cloned repository. The output is an example path that will vary based on your local setup.

```bash
echo $(pwd)"/bin/pod"
# e.g. /Users/orta/spiel/ruby/CocoaPods/bin/pod

```

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

### Tree output of generated MyLib project

Source: https://guides.cocoapods.org/making/using-pod-lib-create

Output of running `pod install` on the newly created project, showing the directory structure of MyLib. The tree lists files like .travis.yml, _Pods.xcproject, Example, LICENSE, MyLib.podspec, MyLib, and README.md.

```bash
$ tree MyLib -L 2

  MyLib
  ├── .travis.yml
  ├── _Pods.xcproject
  ├── Example
  │   ├── MyLib
  │   ├── MyLib.xcodeproj
  │   ├── MyLib.xcworkspace
  │   ├── Podfile
  │   ├── Podfile.lock
  │   ├── Pods
  │   └── Tests
  ├── LICENSE
  ├── MyLib.podspec
  ├── MyLib
  │   ├── Assets
  │   └── Classes
  │     └── RemoveMe.[swift/m]
  └── README.md

```

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

### tvos.source_files example

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets source files for tvOS platform.

```ruby
spec.tvos.source_files = 'Classes/tvos/**/*.{h,m}'
```

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

### Install CocoaPods with --user-install and verify

Source: https://guides.cocoapods.org/using/getting-started.html

Install CocoaPods into your user directory using the --user-install flag, then check where the gem is installed and run pod install with the full path.

```bash
$ gem install cocoapods --user-install
$ gem which cocoapods
/Users/eloy/.gem/ruby/2.0.0/gems/cocoapods-0.29.0/lib/cocoapods.rb
$ /Users/eloy/.gem/ruby/2.0.0/bin/pod install

```

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

### Example Podspec for Reachability

Source: https://guides.cocoapods.org/making/specs-and-specs-repo.html

A complete Podspec example for the Reachability library, showing common attributes like name, version, license, source, and source_files. This is a typical starting point for creating a Podspec.

```ruby
Pod::Spec.new do |spec|
  spec.name             = 'Reachability'
  spec.version          = '3.1.0'
  spec.license          = { :type => 'BSD' }
  spec.homepage         = 'https://github.com/tonymillion/Reachability'
  spec.authors          = { 'Tony Million' => 'tonymillion@gmail.com' }
  spec.summary          = 'ARC and GCD Compatible Reachability Class for iOS and macOS.'
  spec.source           = { :git => 'https://github.com/tonymillion/Reachability.git', :tag => 'v3.1.0' }
  spec.source_files     = 'Reachability.h,m'
  spec.framework        = 'SystemConfiguration'
  spec.requires_arc     = true
end
```

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

### visionos.source_files example

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets source files for visionOS platform.

```ruby
spec.visionos.source_files = 'Classes/visionos/**/*.{h,m}'
```

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

### Multi-platform resources example

Source: https://guides.cocoapods.org/syntax/podspec.html

Shows how to set platform-specific resources: general resources and iOS-specific resources.

```ruby
spec.resources = 'Resources/**/*.png'
spec.ios.resources = 'Resources_ios/**/*.png'
```

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

### watchos.source_files example

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets source files for watchOS platform.

```ruby
spec.watchos.source_files = 'Classes/watchos/**/*.{h,m}'
```

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

### Run specs and build examples

Source: https://guides.cocoapods.org/contributing/dev-environment.html

Run these commands in the gem directory to verify all specs pass and examples build. Use `rake -T` to see other per-gem tasks.

```bash
$ rake spec
$ rake examples:build

```

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

### Edit Podfile and install dependencies

Source: https://guides.cocoapods.org/terminal/commands.html

Opens an existing Podfile for editing and installs the specified dependencies.

```shell
$ vim podfile
$ pod install
```

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

### ios.source_files example

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets source files for iOS platform.

```ruby
spec.ios.source_files = 'Classes/ios/**/*.{h,m}'
```

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

### Install or update pods

Source: https://guides.cocoapods.org/making/making-a-cocoapod.html

Run either `pod install` or `pod update` to install the pod into the Xcode project. These are alternative commands.

```bash
pod install
-- or --
pod update

```

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

### Examples of pod trunk register

Source: https://guides.cocoapods.org/terminal/commands.html

These examples show how to register with different combinations of name and description. The first includes a name and description, the second omits the name, and the third uses only the email.

```shell
$ pod trunk register eloy@example.com `Eloy Durán` --description=`Personal Laptop`
$ pod trunk register eloy@example.com --description=`Work Laptop`
$ pod trunk register eloy@example.com
```

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

### project_header_files example

Source: https://guides.cocoapods.org/syntax/podspec.html

Specifies file patterns for project headers.

```ruby
spec.project_header_files = 'Headers/Project/*.h'

```

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

### Subspecs: install all subspecs

Source: https://guides.cocoapods.org/syntax/podspec.html

Installs ShareKit with all its subspecs (e.g., Evernote, Facebook) by specifying the root pod.

```ruby
pod 'ShareKit', '2.0'
```

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

### File pattern examples for JSONKit

Source: https://guides.cocoapods.org/syntax/podspec.html

Examples of file patterns evaluated in the source root of JSONKit, showing how wildcards match files.

```ruby
"JSONKit.?"    #=> ["JSONKit.h", "JSONKit.m"]
"*.[a-z][a-z]" #=> ["CHANGELOG.md", "README.md"]
"*.[^m]*"      #=> ["JSONKit.h"]
"*.{h,m}"      #=> ["JSONKit.h", "JSONKit.m"]
"*"            #=> ["CHANGELOG.md", "JSONKit.h", "JSONKit.m", "README.md"]

```

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

### Podspec with Subspecs for ShareKit

Source: https://guides.cocoapods.org/making/specs-and-specs-repo.html

Shows how to define subspecs within a Podspec, allowing users to install only a subset of the library. The example includes 'Evernote' and 'Facebook' subspecs with specific source files and dependencies.

```ruby
Pod::Spec.new do |spec|
  spec.name          = 'ShareKit'
  spec.source_files  = 'Classes/ShareKit/{Configuration,Core,Customize UI,UI}/**/*.{h,m,c}'
  # ...

  spec.subspec 'Evernote' do |evernote|
    evernote.source_files = 'Classes/ShareKit/Sharers/Services/Evernote/**/*.{h,m}'
  end

  spec.subspec 'Facebook' do |facebook|
    facebook.source_files   = 'Classes/ShareKit/Sharers/Services/Facebook/**/*.{h,m}'
    facebook.compiler_flags = '-Wno-incomplete-implementation -Wno-missing-prototypes'
    facebook.dependency 'Facebook-iOS-SDK'
  end
  # ...
end
```

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

### osx.source_files example

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets source files for OS X platform.

```ruby
spec.osx.source_files = 'Classes/osx/**/*.{h,m}'
```

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

### app_spec example

Source: https://guides.cocoapods.org/syntax/podspec.html

Defines an app specification with source files and a dependency.

```ruby
Pod::Spec.new do |spec|
  spec.name = 'NSAttributedString+CCLFormat'

  spec.app_spec do |app_spec|
    app_spec.source_files = 'NSAttributedString+CCLFormat.m'
    app_spec.dependency 'AFNetworking'
  end
end
```

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

### platform specification examples

Source: https://guides.cocoapods.org/syntax/podfile.html

Shows two ways to specify the platform: with an explicit deployment target ('4.0') and without, which uses the default deployment target for the platform.

```ruby
platform :ios, '4.0'
platform :ios
```

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

### Install pre-release version of CocoaPods

Source: https://guides.cocoapods.org/using/getting-started.html

Use the --pre flag to install a pre-release version of CocoaPods.

```bash
$ [sudo] gem install cocoapods --pre

```

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

### Download and open a pod's demo project with pod try

Source: https://guides.cocoapods.org/terminal/commands.html

Downloads the Pod with the given NAME (or Git URL), installs its dependencies if needed, and opens its demo project. If a Git URL is provided, the head of the repo is used. Use --podspec_name if the podspec name differs from the Git repo.

```shell
pod try NAME|URL
```

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

### Install CocoaPods with sudo to /usr/local/bin

Source: https://guides.cocoapods.org/using/troubleshooting

Use this command if you get the error 'ERROR: While executing gem ... (Errno::EPERM); Operation not permitted - /usr/bin/fuzzy_match'.

```bash
$ sudo gem install -n /usr/local/bin cocoapods

```

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

### Gemfile for CocoaPods dependencies

Source: https://guides.cocoapods.org/using/a-gemfile.html

Example Gemfile from a Cocoa project. It specifies a source and lists gems, including CocoaPods and plugins, with optional version constraints. Running bundle install generates a Gemfile.lock that locks exact versions.

```ruby
source 'https://rubygems.org'

gem 'cocoapods'
gem 'cocoapods-keys'

gem 'fui', '~> 0.3.0'
gem 'xcpretty'
gem 'second_curtain', '~> 0.2.3'
gem 'fastlane'

```

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

### Podfile with cocoapods-binary plugin and :binary => true

Source: https://guides.cocoapods.org/plugins/pre-compiling-dependencies.html

Modify the Podfile to enable the cocoapods-binary plugin and mark a specific pod for pre-compilation by appending ':binary => true'. The example shows the change from 'pod "ExpectoPatronum"' to 'pod "ExpectoPatronum", :binary => true' inside the target "HP". After editing, run 'bundle exec pod install'.

```ruby
  plugin 'cocoapods-binary'
  use_frameworks!

  target "HP" do
-      pod "ExpectoPatronum"
+      pod "ExpectoPatronum", :binary => true
  end

```

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

### Pod with multiple subspecs

Source: https://guides.cocoapods.org/syntax/podfile.html

Installs a collection of subspecs for a Pod.

```ruby
pod 'QueryKit', :subspecs => ['Attribute', 'QuerySet']

```

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

### Run pod install with custom binary

Source: https://guides.cocoapods.org/using/unreleased-features.html

Uses the full path to the custom 'pod' binary to run 'pod install' in your project directory, allowing you to use the branch version of CocoaPods.

```bash
cd ~/projects/dev/eidolon
/Users/orta/spiel/ruby/CocoaPods/bin/pod install

```

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

### vendored_frameworks iOS example

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets the path of a framework bundle for iOS.

```ruby
spec.ios.vendored_frameworks = 'Frameworks/MyFramework.framework'

```

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

### List installed CocoaPods plugins

Source: https://guides.cocoapods.org/terminal/commands.html

Use `pod plugins installed` to list all installed plugins and their versions.

```shell
pod plugins installed 
```

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

### Gemfile using CocoaPods master

Source: https://guides.cocoapods.org/using/a-gemfile.html

Example Gemfile that uses unreleased versions of CocoaPods and related gems from their Git repositories. Running bundle install fetches the master versions. Additional dependencies may be needed because CocoaPods is split into multiple gems.

```ruby
source 'https://rubygems.org'

gem 'cocoapods', :git => 'https://github.com/CocoaPods/CocoaPods.git'
gem 'cocoapods-core', :git => 'https://github.com/CocoaPods/Core.git'
gem 'xcodeproj', :git => 'https://github.com/CocoaPods/Xcodeproj.git'

gem 'cocoapods-keys', :git => 'https://github.com/orta/cocoapods-keys.git'

gem 'xcpretty'
gem 'shenzhen'
gem 'sbconstants'

```

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

### Install CocoaPods with sudo

Source: https://guides.cocoapods.org/using/getting-started.html

Use sudo when installing gems if you are using the default Ruby included with macOS. This is only needed during gem installation.

```bash
$ sudo gem install cocoapods

```

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

### Add pod from git repository

Source: https://guides.cocoapods.org/making/making-a-cocoapod.html

Add this line to a Podfile to install a pod from a git repository. Used for testing installation in an Xcode project.

```ruby
pod 'NAME', :git => 'https://example.com/URL/to/repo/NAME.git'

```

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

### Add artsy-specs repo to CocoaPods

Source: https://guides.cocoapods.org/making/private-cocoapods

Add the example private repo 'artsy-specs' using its URL.

```bash
$ pod repo add artsy-specs https://github.com/artsy/Specs.git

```

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

### vendored_library iOS example

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets the path of a library for iOS.

```ruby
spec.ios.vendored_library = 'Libraries/libProj4.a'

```

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

### Bootstrap a new pod with pod lib create

Source: https://guides.cocoapods.org/making/using-pod-lib-create

Run this command to start the interactive creation of a new CocoaPods library. You can add `--template-url=URL` to use a custom template, and pressing return selects the default (underlined) option.

```bash
pod lib create MyLibrary

```

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

### Install CocoaPods with gem

Source: https://guides.cocoapods.org/using/getting-started.html

Run this command to install CocoaPods using RubyGems. If using the default macOS Ruby, you may need to use sudo.

```bash
$ gem install cocoapods

```

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

### pre_install

Source: https://guides.cocoapods.org/syntax/podfile.html

Defines a hook that allows you to make changes to the Pods after they have been downloaded but before they are installed. It receives the Pod::Installer as its only argument.

```APIDOC
## pre_install

### Description
This hook allows you to make any changes to the Pods after they have been downloaded but before they are installed. It receives the [Pod::Installer] as its only argument.

### Parameters
- **installer** (Pod::Installer) - Required - The installer object.

### Examples
```ruby
pre_install do |installer|
  # Do something fancy!
end
```
```

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

### public_header_files example

Source: https://guides.cocoapods.org/syntax/podspec.html

Specifies file patterns for public headers.

```ruby
spec.public_header_files = 'Headers/Public/*.h'

```

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

### Pod with specific subspec

Source: https://guides.cocoapods.org/syntax/podfile.html

Installs a specific subspec of a Pod.

```ruby
pod 'QueryKit/Attribute'

```

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

### private_header_files example

Source: https://guides.cocoapods.org/syntax/podspec.html

Specifies file patterns for private headers.

```ruby
spec.private_header_files = 'Headers/Private/*.h'

```

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

### Define a pre_install hook

Source: https://guides.cocoapods.org/syntax/podfile.html

The pre_install hook is called after dependencies are downloaded but before installation. It receives the Pod::Installer as its only argument.

```ruby
pre_install do |installer|
  # Do something fancy!
end

```

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

### test_spec example

Source: https://guides.cocoapods.org/syntax/podspec.html

Defines a test specification with source files and a dependency.

```ruby
Pod::Spec.new do |spec|
  spec.name = 'NSAttributedString+CCLFormat'

  spec.test_spec do |test_spec|
    test_spec.source_files = 'NSAttributedString+CCLFormatTests.m'
    test_spec.dependency 'Expecta'
  end
end
```

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

### Run pod install

Source: https://guides.cocoapods.org/terminal/commands.html

Downloads all dependencies defined in the Podfile and creates an Xcode Pods library project in ./Pods. May return error code 1 for generic errors or 31 for spec not found.

```bash
pod install 
```

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

### Podfile with dependencies for MyApp target

Source: https://guides.cocoapods.org/using/using-cocoapods.html

Defines a Podfile with a target 'MyApp' and two pod dependencies: AFNetworking and FBSDKCoreKit. This is the initial Podfile created during installation.

```ruby
target 'MyApp' do
  pod 'AFNetworking', '~> 3.0'
  pod 'FBSDKCoreKit', '~> 4.9'
end

```

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

### plugin

Source: https://guides.cocoapods.org/syntax/podfile.html

Specifies a plugin to be used during installation, along with optional options passed to the plugin when its hooks are invoked.

```APIDOC
## plugin

### Description
Specifies a plugin that should be used during installation, along with the options that should be passed to the plugin when it is invoked.

### Parameters
- **name** (String) - Required - The name of the plugin.
- **options** (Hash) - Optional - The optional options that should be passed to the plugin when its hooks are invoked.

### Examples
```ruby
plugin 'cocoapods-keys', :keyring => 'Eidolon'
plugin 'slather'
```
```

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

### Verify private spec repo installation

Source: https://guides.cocoapods.org/making/private-cocoapods

Check that your private spec repo was added correctly by navigating to the repo directory and running `pod repo lint .`.

```bash
$ cd ~/.cocoapods/repos/REPO_NAME
$ pod repo lint .

```

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

### Target inheritance example with ShowsKit, ShowWebAuth, ShowTVAuth, and test targets

Source: https://guides.cocoapods.org/syntax/podfile.html

Shows a Podfile with an abstract target 'Shows' and three child targets: ShowsiOS, ShowsTV, and ShowsTests. The tests target uses 'inherit! :search_paths' to only inherit search paths, while the other targets inherit all behavior by default.

```ruby
target 'Shows' do
  pod 'ShowsKit'

  # The target ShowsiOS has its own copy of ShowsKit (inherited) + ShowWebAuth (added here)
  target 'ShowsiOS' do
    pod 'ShowWebAuth'
  end

  # The target ShowsTV has its own copy of ShowsKit (inherited) + ShowTVAuth (added here)
  target 'ShowsTV' do
    pod 'ShowTVAuth'
  end

  # Our tests target has its own copy of
  # our testing frameworks, and has access
  # to ShowsKit as well because it is
  # a child of the abstract target 'Shows'

  target 'ShowsTests' do
    inherit! :search_paths
    pod 'Specta'
    pod 'Expecta'
  end
end
```

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

### Example Podspec for Artsy+OSSUIFonts

Source: https://guides.cocoapods.org/making/private-cocoapods

A typical Podspec file for a private pod, including name, version, source, and configuration.

```ruby
Pod::Spec.new do |s|
  s.name             = "Artsy+OSSUIFonts"
  s.version          = "1.1.1"
  s.summary          = "The open source fonts for Artsy apps + UIFont categories."
  s.homepage         = "https://github.com/artsy/Artsy-OSSUIFonts"
  s.license          = 'Code is MIT, then custom font licenses.'
  s.author           = { "Orta" => "orta.therox@gmail.com" }
  s.source           = { :git => "https://github.com/artsy/Artsy-OSSUIFonts.git", :tag => s.version }
  s.social_media_url = 'https://twitter.com/artsy'

  s.platform     = :ios, '7.0'
  s.requires_arc = true

  s.source_files = 'Pod/Classes'
  s.resources = 'Pod/Assets/*'

  s.frameworks = 'UIKit', 'CoreText'
  s.module_name = 'Artsy_UIFonts'
end

```

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

### Verify artsy-specs repo installation

Source: https://guides.cocoapods.org/making/private-cocoapods

Check that the artsy-specs repo was added correctly.

```bash
$ cd ~/.cocoapods/repos/artsy-specs
$ pod repo lint .

```

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

### Configure RubyGems user directory in .bash_profile

Source: https://guides.cocoapods.org/using/getting-started.html

Add these lines to your .bash_profile to install gems into your user directory without admin privileges. This is the recommended approach for sudo-less installation.

```bash
export GEM_HOME=$HOME/.gem
export PATH=$GEM_HOME/bin:$PATH

```

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

### default_subspec example

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets a single default subspec.

```ruby
spec.default_subspec = 'Core'
```

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

### requires_app_host example

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets the test specification to require an app host for running tests.

```ruby
test_spec.requires_app_host = true
```

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

### Simple Podspec for libPusher

Source: https://guides.cocoapods.org/making/specs-and-specs-repo.html

A minimal Podspec example for the libPusher library, demonstrating the essential attributes and a dependency on SocketRocket.

```ruby
Pod::Spec.new do |spec|
  spec.name         = 'libPusher'
  spec.version      = '1.3'
  spec.license      = 'MIT'
  spec.summary      = 'An Objective-C client for the Pusher.com service'
  spec.homepage     = 'https://github.com/lukeredpath/libPusher'
  spec.author       = 'Luke Redpath'
  spec.source       = { :git => 'git://github.com/lukeredpath/libPusher.git', :tag => 'v1.3' }
  spec.source_files = 'Library/*'
  spec.requires_arc = true
  spec.dependency 'SocketRocket'
end
```

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

### inherit! :search_paths example

Source: https://guides.cocoapods.org/syntax/podfile.html

Shows a target 'App' with a child target 'AppTests' that inherits only the search paths from its parent using 'inherit! :search_paths'.

```ruby
target 'App' do
  target 'AppTests' do
    inherit! :search_paths
  end
end
```

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

### Use a local path with :path

Source: https://guides.cocoapods.org/using/the-podfile.html

Use `:path` to link a Pod directly from a local folder, allowing edits to persist between installations. The folder must contain the podspec.

```ruby
pod 'Alamofire', :path => '~/Documents/Alamofire'

```

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

### Detailed Pod::Spec definition with platform-specific settings

Source: https://guides.cocoapods.org/syntax/podspec.html

A more detailed podspec example that adds module_name, swift_version, deployment targets, platform-specific source files and frameworks, and a dependency.

```ruby
Pod::Spec.new do |spec|
  spec.name          = 'Reachability'
  spec.version       = '3.1.0'
  spec.license       = { :type => 'BSD' }
  spec.homepage      = 'https://github.com/tonymillion/Reachability'
  spec.authors       = { 'Tony Million' => 'tonymillion@gmail.com' }
  spec.summary       = 'ARC and GCD Compatible Reachability Class for iOS and OS X.'
  spec.source        = { :git => 'https://github.com/tonymillion/Reachability.git', :tag => 'v3.1.0' }
  spec.module_name   = 'Rich'
  spec.swift_version = '4.0'

  spec.ios.deployment_target  = '9.0'
  spec.osx.deployment_target  = '10.10'

  spec.source_files       = 'Reachability/common/*.swift'
  spec.ios.source_files   = 'Reachability/ios/*.swift', 'Reachability/extensions/*.swift'
  spec.osx.source_files   = 'Reachability/osx/*.swift'

  spec.framework      = 'SystemConfiguration'
  spec.ios.framework  = 'UIKit'
  spec.osx.framework  = 'AppKit'

  spec.dependency 'SomeOtherPod'
end

```

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

### Example of pod targets with deduplication

Source: https://guides.cocoapods.org/syntax/podfile.html

Shows two targets that include the same pod with different subspecs, leading to two pod targets: MyPod and MyPod-SubA. This is used to illustrate the :deduplicate_targets option.

```ruby
target 'MyTargetA' do
  pod 'MyPod/SubA'
end

target 'MyTargetB' do
  pod 'MyPod'
end

```

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

### Implicit abstract target at the root of the Podfile

Source: https://guides.cocoapods.org/using/the-podfile.html

Shows the equivalent of the abstract_target example using the implicit abstract target at the root of the Podfile, without explicitly declaring an abstract_target.

```ruby
pod 'ShowsKit'
pod 'Fabric'

# Has its own copy of ShowsKit + ShowWebAuth
target 'ShowsiOS' do
  pod 'ShowWebAuth'
end

# Has its own copy of ShowsKit + ShowTVAuth
target 'ShowsTV' do
  pod 'ShowTVAuth'
end
```

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

### Open Xcode workspace after pod install

Source: https://guides.cocoapods.org/terminal/commands.html

Opens the generated .xcworkspace file to work on the project with CocoaPods dependencies.

```shell
$ open *.xcworkspace
```

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

### Define a simple script phase

Source: https://guides.cocoapods.org/syntax/podspec.html

Adds a script phase that executes during compilation. A warning is shown to the user upon installation if any script phases are included.

```ruby
spec.script_phase = { :name => 'Hello World', :script => 'echo "Hello World"' }

```

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

### Subspecs: install specific subspecs

Source: https://guides.cocoapods.org/syntax/podspec.html

Installs only the specified subspecs of ShareKit.

```ruby
pod 'ShareKit/Twitter',  '2.0'
pod 'ShareKit/Pinboard', '2.0'
```

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

### Specifying the latest version of a pod by omitting version requirements

Source: https://guides.cocoapods.org/using/the-podfile.html

When starting out with a project, you may want to use the latest version of a Pod. Simply omit the version requirements.

```ruby
pod 'SSZipArchive'
```

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

### Configure cocoapods-keys plugin in Podfile

Source: https://guides.cocoapods.org/plugins/environment-vars.html

Add the plugin section to your Podfile, specifying the project, target, and the list of keys to use. When you run bundle exec pod install, CocoaPods Keys will create a new Pod containing all your keys.

```ruby
plugin 'cocoapods-keys',
       project: 'Artsy',
       target: 'Artsy',
       keys: [
         'ArtsyAPIClientSecret',      # Auth for the Artsy API
         'ArtsyAPIClientKey',         #
         'ArtsyFacebookAppID',        # Supporting FB Login
       ]

```

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

### Create a bare Git repo for private specs

Source: https://guides.cocoapods.org/making/private-cocoapods

Create a bare Git repository on your server to host your private spec repo.

```bash
$ cd /opt/git
$ mkdir Specs.git
$ cd Specs.git
$ git init --bare

```

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

### Set prepare_command with heredoc script

Source: https://guides.cocoapods.org/syntax/podspec.html

Runs a multi-line bash script after the pod is downloaded. The working directory is the pod root.

```ruby
spec.prepare_command = <<-CMD
                        sed -i 's/MyNameSpacedHeader/Header/g' ./**/*.h
                        sed -i 's/MyNameOtherSpacedHeader/OtherHeader/g' ./**/*.h
                   CMD
```

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

### Run pod ipc repl

Source: https://guides.cocoapods.org/terminal/commands.html

Starts an interactive REPL that listens for commands on standard input and prints results to standard output. It accepts all other ipc subcommands and signals the end of output with the ASCII CR+LF sequence \n\r.

```shell
pod ipc repl 
```

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

### Set prepare_command with single command

Source: https://guides.cocoapods.org/syntax/podspec.html

Runs a bash script after the pod is downloaded, before cleaning and project creation. Not executed when using the :path option.

```ruby
spec.prepare_command = 'ruby build_files.rb'
```

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

### Update CocoaPods

Source: https://guides.cocoapods.org/using/getting-started.html

To update CocoaPods, simply install the gem again. Use sudo if you originally installed with sudo.

```bash
$ [sudo] gem install cocoapods

```

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

### on_demand_resources: with category :initial_install

Source: https://guides.cocoapods.org/syntax/podspec.html

Defines an on-demand resource with explicit category `:initial_install`.

```ruby
s.on_demand_resources = {
  'Tag1' => { :paths => ['file1.png', 'file2.png'], :category => :initial_install }
}
```

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

### Register a new account with pod trunk register

Source: https://guides.cocoapods.org/terminal/commands.html

Use this command to register a new account or create a new session. For first registration, both EMAIL and YOUR_NAME are required; otherwise YOUR_NAME can be omitted. The --description option helps identify the session later.

```shell
pod trunk register EMAIL [YOUR_NAME]
```

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

### Podfile dependency declaration

Source: https://guides.cocoapods.org/using/using-cocoapods.html

Specifies a dependency on the RestKit pod in the Podfile. Running pod install will install the current version and generate a Podfile.lock that records the exact version.

```ruby
pod 'RestKit'

```

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

### spec.frameworks = 'QuartzCore', 'CoreData'

Source: https://guides.cocoapods.org/syntax/podspec.html

Links multiple system frameworks.

```ruby
spec.frameworks = 'QuartzCore', 'CoreData'

```

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

### scheme with launch arguments and environment variables

Source: https://guides.cocoapods.org/syntax/podspec.html

Configures the scheme with multiple launch arguments and environment variables.

```ruby
spec.scheme = { :launch_arguments => ['Arg1', 'Arg2'], :environment_variables => { 'Key1' => 'Val1'} }
```

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

### Register with Trunk

Source: https://guides.cocoapods.org/making/getting-setup-with-trunk

Registers a new Trunk account and begins a session on the current device. The --description flag provides context for the session. You must click a link in the verification email to complete the connection.

```bash
$ pod trunk register orta@cocoapods.org 'Orta Therox' --description='macbook air'

```

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

### List all available pods with pod list

Source: https://guides.cocoapods.org/terminal/commands.html

Lists all available pods. Use --update to run pod repo update before listing, or --stats to show additional stats like GitHub watchers and forks.

```shell
pod list 
```

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

### Use :path option for local development

Source: https://guides.cocoapods.org/making/making-a-cocoapod.html

Use this in a Podfile to work on a library from its local folder. The `:path` option points to the local directory.

```ruby
pod 'Name', :path => '~/code/Pods/'

```

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

### Pod without version requirement

Source: https://guides.cocoapods.org/syntax/podfile.html

Declares a dependency with no version requirement, which installs the latest version.

```ruby
pod 'SSZipArchive'

```

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

### post_install

Source: https://guides.cocoapods.org/syntax/podfile.html

Defines a hook that allows you to make any last changes to the generated Xcode project before it is written to disk, or any other tasks you might want to perform. It receives the Pod::Installer as its only argument.

```APIDOC
## post_install

### Description
This hook allows you to make any last changes to the generated Xcode project before it is written to disk, or any other tasks you might want to perform. It receives the [Pod::Installer] as its only argument.

### Parameters
- **installer** (Pod::Installer) - Required - The installer object.

### Examples
```ruby
post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['GCC_ENABLE_OBJC_GC'] = 'supported'
    end
  end
end
```
```

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

### Lint pod with pod lib lint

Source: https://guides.cocoapods.org/making/making-a-cocoapod.html

Run these commands in the pod's directory to test the syntax of the Podfile. This does not test the downloading aspect of linting.

```bash
$ cd ~/code/Pods/NAME
$ pod lib lint

```

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

### Initialize a Podfile with pod init

Source: https://guides.cocoapods.org/terminal/commands.html

Creates a Podfile for the current directory if none exists. If an XCODEPROJ project file is specified or only one project file is present, targets are automatically generated from the project. Dependencies can be specified in template files Podfile.default and Podfile.test stored in the CocoaPods templates folder.

```shell
pod init XCODEPROJ
```

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

### Pod with build configurations array

Source: https://guides.cocoapods.org/syntax/podfile.html

Limits the dependency to a list of build configurations.

```ruby
pod 'PonyDebugger', :configurations => ['Debug', 'Beta']

```

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

### Get pod information with pod trunk info

Source: https://guides.cocoapods.org/terminal/commands.html

Use this command to retrieve information about a specific pod. The pod is identified by its name.

```shell
pod trunk info NAME
```

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

### pre_integrate

Source: https://guides.cocoapods.org/syntax/podfile.html

Defines a hook that allows you to make changes before the project is written to disk. It receives the Pod::Installer as its only argument.

```APIDOC
## pre_integrate

### Description
This hook allows you to make changes before the project is written to disk. It receives the [Pod::Installer] as its only argument.

### Parameters
- **installer** (Pod::Installer) - Required - The installer object.

### Examples
```ruby
pre_integrate do |installer|
  # perform some changes on dependencies
end
```
```

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

### post_integrate

Source: https://guides.cocoapods.org/syntax/podfile.html

Defines a hook that allows you to make changes after the project is written to disk. It receives the Pod::Installer as its only argument.

```APIDOC
## post_integrate

### Description
This hook allows you to make changes after the project is written to disk. It receives the [Pod::Installer] as its only argument.

### Parameters
- **installer** (Pod::Installer) - Required - The installer object.

### Examples
```ruby
post_integrate do |installer|
  # Customizing the build settings of all targets
end
```
```

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

### Update Pods with pod update

Source: https://guides.cocoapods.org/terminal/commands.html

Updates the specified pods or all pods if none are specified, ignoring Podfile.lock. Use pod install for Podfile changes.

```shell
pod update [POD_NAMES ...]
```

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

### Complex Podfile with platform, warnings, nested targets, and post_install hook

Source: https://guides.cocoapods.org/syntax/podfile.html

A more advanced Podfile that sets the iOS platform to 9.0, inhibits all warnings, defines a target 'MyApp' with a dependency, nests a test target that inherits search paths, and includes a post_install hook that prints each target name.

```ruby
platform :ios, '9.0'
inhibit_all_warnings!

target 'MyApp' do
  pod 'ObjectiveSugar', '~> 0.5'

  target 'MyAppTests' do
    inherit! :search_paths
    pod 'OCMock', '~> 2.0.1'
  end
end

post_install do |installer|
  installer.pods_project.targets.each do |target|
    puts "#{target.name}"
  end
end

```

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

### View your registration and sessions with pod trunk me

Source: https://guides.cocoapods.org/terminal/commands.html

Use this command to see your registration details and all your sessions, including current, valid, unverified, and expired sessions.

```shell
pod trunk me 
```

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

### Run pod check in CI

Source: https://guides.cocoapods.org/plugins/optimising-ci-times.html

Use this command in your CI pipeline to execute pod install only when the check fails, indicating that dependencies need to be updated.

```bash
bundle exec pod check || bundle exec pod install
```

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

### Podfile: Add dependency without version requirement

Source: https://guides.cocoapods.org/making/making-a-cocoapod.html

Adds the CocoaLumberjack pod without a version requirement, so pod install uses the latest version.

```ruby
pod 'CocoaLumberjack'

```

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

### Run pod command with full path

Source: https://guides.cocoapods.org/contributing/dev-environment.html

Run the latest pod command in your project by specifying the full path to the pod binary.

```bash
path/to/CocoaPods/CocoaPods/bin/pod install

```

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

### Podfile: Specify a development pod with :path

Source: https://guides.cocoapods.org/making/development-cocoapods.html

Use this in your Podfile to reference a local checkout of your pod's repository instead of a versioned release. This is required to develop the pod in concert with an app.

```ruby
pod 'AwesomeView', '~> 1.42.0'

```

```ruby
pod 'AwesomeView', :path => '/Users/yourusername/path/to/pod/repo/AwesomeView'

```

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

### script_phase with shell script

Source: https://guides.cocoapods.org/syntax/podfile.html

Adds a script phase to a target that executes an arbitrary script using Xcode environment variables. This example uses a shell script.

```ruby
script_phase :name => 'HelloWorldScript', :script => 'echo "Hello World"'
```

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

### scheme with launch arguments

Source: https://guides.cocoapods.org/syntax/podspec.html

Configures the scheme with a single launch argument.

```ruby
spec.scheme = { :launch_arguments => ['Arg1'] }
```

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

### Delete Pods directory to fix permission errors

Source: https://guides.cocoapods.org/using/troubleshooting

If permission errors persist after deleting global files, delete the Pods directory in your project and then run pod install.

```bash
$ sudo rm -fr Pods/

```

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

### Pod from local path

Source: https://guides.cocoapods.org/syntax/podfile.html

Uses a local path as the source for a Pod, linking files directly.

```ruby
pod 'AFNetworking', :path => '~/Documents/AFNetworking'

```

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

### Simple Podfile with a single target and dependency

Source: https://guides.cocoapods.org/syntax/podfile.html

A minimal Podfile that declares a target 'MyApp' and adds the AFNetworking pod with a version requirement of '~> 1.0'. This is the most basic form of a Podfile.

```ruby
target 'MyApp'
pod 'AFNetworking', '~> 1.0'

```

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

### Simple Pod::Spec definition

Source: https://guides.cocoapods.org/syntax/podspec.html

A minimal podspec example for the Reachability library, setting name, version, license, homepage, authors, summary, source, source_files, and framework.

```ruby
Pod::Spec.new do |spec|
  spec.name         = 'Reachability'
  spec.version      = '3.1.0'
  spec.license      = { :type => 'BSD' }
  spec.homepage     = 'https://github.com/tonymillion/Reachability'
  spec.authors      = { 'Tony Million' => 'tonymillion@gmail.com' }
  spec.summary      = 'ARC and GCD Compatible Reachability Class for iOS and OS X.'
  spec.source       = { :git => 'https://github.com/tonymillion/Reachability.git', :tag => 'v3.1.0' }
  spec.source_files = 'Reachability.{h,m}'
  spec.framework    = 'SystemConfiguration'
end

```

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

### Set README URL

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets the URL for the README markdown file for this pod version.

```ruby
spec.readme = 'https://www.example.com/Pod-1.5-README.md'

```

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

### Create a Podspec file

Source: https://guides.cocoapods.org/making/private-cocoapods

Create a new Podspec file using the touch command.

```bash
cd ~/Desktop
touch Artsy+OSSUIFonts.podspec

```

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

### Specify Xcode project in Podfile

Source: https://guides.cocoapods.org/terminal/commands.html

Sets the Xcode project file to be used by pod install. If no project is specified, CocoaPods searches for one and raises an error if more than one is found.

```ruby
project `path/to/XcodeProject.xcodeproj`

```

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

### Run full test suite with bundle exec rake

Source: https://guides.cocoapods.org/contributing/contribute-to-cocoapods.html

Command to run the full CocoaPods test suite. Also shows how to run a single test suite, e.g., functional tests.

```bash
$ bundle exec rake

# Or to run a single test suite:
$ bundle exec rake spec:functional

```

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

### Include a test spec in a Podfile

Source: https://guides.cocoapods.org/using/test-specs.html

Brings the 'Tests' test specification of the CoconutLib pod into the MyApp target. Running pod install creates a test target in Pods.xcodeproj for the pod.

```ruby
target 'MyApp' do
  use_frameworks!
  pod 'CoconutLib', '~> 1.0', :testspecs => ['Tests'] 
end

```

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

### Create bash alias for custom pod command

Source: https://guides.cocoapods.org/using/unreleased-features.html

Creates a bash alias 'spod' that points to the custom 'pod' binary, allowing you to run 'spod install' instead of the full path.

```bash
alias spod='/Users/orta/spiel/ruby/CocoaPods/bin/pod'

```

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

### pod ipc list

Source: https://guides.cocoapods.org/terminal/commands.html

Prints to STDOUT a YAML dictionary where keys are specification names and values contain defined_in_file, version, authors, summary, description, and platforms. Inherited options include --allow-root, --silent, --verbose, --no-ansi, and --help.

```bash
pod ipc list 
```

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

### abstract_target defining a target with dependencies

Source: https://guides.cocoapods.org/syntax/podfile.html

Defines an abstract target that can be used for convenient target dependency inheritance. This example defines an abstract target 'Networking' with a pod and two concrete targets.

```ruby
abstract_target 'Networking' do
  pod 'AlamoFire'

  target 'Networking App 1'
  target 'Networking App 2'
end
```

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

### source_files multiple patterns

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets the source files of the Pod using multiple file patterns.

```ruby
spec.source_files = 'Classes/**/*.{h,m}', 'More_Classes/**/*.{h,m}'

```

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

### pod plugins list

Source: https://guides.cocoapods.org/terminal/commands.html

Lists all known plugins according to the list hosted on github.com/CocoaPods/cocoapods-plugins. Inherited options include --allow-root, --silent, --verbose, --no-ansi, and --help.

```bash
pod plugins list 
```

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

### Add a private spec repo to CocoaPods

Source: https://guides.cocoapods.org/making/private-cocoapods

Use `pod repo add REPO_NAME SOURCE_URL` to add your private spec repository to your local CocoaPods installation. Replace REPO_NAME and SOURCE_URL with your repo's name and URL.

```bash
$ pod repo add REPO_NAME SOURCE_URL

```

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

### Create a PodSpec with pod spec create

Source: https://guides.cocoapods.org/terminal/commands.html

Creates a PodSpec in the current working directory called NAME.podspec. If a GitHub URL is passed, the spec is prepopulated.

```shell
pod spec create [NAME|https://github.com/USER/REPO]
```

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

### Define script phase with input and output files

Source: https://guides.cocoapods.org/syntax/podspec.html

Adds a script phase that declares input and output files for build dependency tracking.

```ruby
spec.script_phase = { :name => 'Hello World', :script => 'echo "Hello World"',
  :input_files => ['/path/to/input_file.txt'], :output_files => ['/path/to/output_file.txt']
}

```

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

### spec.osx.deployment_target = '10.8'

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets the minimum OS X deployment target to 10.8.

```ruby
spec.osx.deployment_target = '10.8'

```

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

### use_frameworks! with dynamic and static linkage

Source: https://guides.cocoapods.org/syntax/podfile.html

Shows how to specify :linkage => :dynamic or :static for use_frameworks! in different targets.

```ruby
target 'MyApp' do
  use_frameworks! :linkage => :dynamic
  pod 'AFNetworking', '~> 1.0'
end

target 'ZipApp' do
  use_frameworks! :linkage => :static
  pod 'SSZipArchive'
end
```

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

### spec.platform = :osx, '10.8'

Source: https://guides.cocoapods.org/syntax/podspec.html

Sets the platform to OS X with a deployment target of 10.8.

```ruby
spec.platform = :osx, '10.8'

```

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

### Push Artsy+OSSUIFonts podspec

Source: https://guides.cocoapods.org/making/private-cocoapods

Push the Artsy+OSSUIFonts podspec to the artsy-specs repo.

```bash
pod repo push artsy-specs ~/Desktop/Artsy+OSSUIFonts.podspec

```

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

### Podspec with Subspecs within Submodules for SDLoginKit

Source: https://guides.cocoapods.org/making/specs-and-specs-repo.html

Demonstrates how to set the :submodules key to true in the source hash and then define subspecs, as shown with the SDKit subspec.

```ruby
Pod::Spec.new do |spec|
  spec.name          = 'SDLoginKit'
  spec.source        =  { 
      :git => 'https://github.com/dulaccc/SDLoginKit.git',
      :tag => '1.0.2', 
      :submodules => true 
  }
  # ...

  spec.subspec 'SDKit' do |sdkit|
    sdkit.source_files = 'SDKit/**/*.{h,m}'
    sdkit.resources    = 'SDKit/**/Assets/*.png'
  end
  # ...
end
```
Tokens:
Raw