CINXE.COM

<!DOCTYPE html><html><head><title>CocoaPods Guides - Home</title><link rel="shortcut icon" href="https://cocoapods.org/favicons/favicon.ico" type="image/x-icon" /><link rel="apple-touch-icon" href="https://cocoapods.org/favicons/apple-touch-icon.png" /><link rel="apple-touch-icon" sizes="57x57" href="https://cocoapods.org/favicons/apple-touch-icon-57x57.png" /><link rel="apple-touch-icon" sizes="60x60" href="https://cocoapods.org/favicons/apple-touch-icon-60x60.png" /><link rel="apple-touch-icon" sizes="72x72" href="https://cocoapods.org/favicons/apple-touch-icon-72x72.png" /><link rel="apple-touch-icon" sizes="76x76" href="https://cocoapods.org/favicons/apple-touch-icon-76x76.png" /><link rel="apple-touch-icon" sizes="114x114" href="https://cocoapods.org/favicons/apple-touch-icon-114x114.png" /><link rel="apple-touch-icon" sizes="120x120" href="https://cocoapods.org/favicons/apple-touch-icon-120x120.png" /><link rel="apple-touch-icon" sizes="144x144" href="https://cocoapods.org/favicons/apple-touch-icon-144x144.png" /><link rel="apple-touch-icon" sizes="152x152" href="https://cocoapods.org/favicons/apple-touch-icon-152x152.png" /><meta charset="utf-8" /><meta content="cocoapods objective-c objc swift package manager libraries documentation search pods podspec podfile cocoa apple ios library" name="keywords" /><meta content="IE=edge" http-equiv="X-UA-Compatible" /><meta content="width=device-width, initial-scale=1.0" name="viewport" /><meta content="The Dependency Manager for iOS & Mac projects" name="description" /><meta content="CocoaPods Dev Team" name="author" /><meta content="summary" name="twitter:card" /><meta content="@CocoaPods" name="twitter:site" /><meta content="@CocoaPods" name="twitter:creator" /><meta content="CocoaPods.org" name="twitter:title" /><meta content="The Dependency Manager for iOS & Mac projects." name="twitter:description" /><meta content="https://www.cocoapods.org/" name="twitter:url" /><link href="stylesheets/app.css" rel="stylesheet" /><script src="javascripts/application.js"></script><meta content="CocoaPods Guides" name="twitter:title" /><meta content="The official documentation site for the CocoaPods dependency manager." name="twitter:description" /><meta content="CocoaPods Guides" property="og:site_name" /><meta content="CocoaPods Guides" property="og:title" /><meta content="https://guides.cocoapods.org" property="og:url" /></head><body><nav class="navbar navbar-static-top" role="navigation"><section class="container"><div class="navbar-header"><button class="navbar-toggle" data-target=".navbar-header-collapse" data-toggle="collapse" type="button"><span class="sr-only">Toggle navigation</span><span class="glyphicon glyphicon-plus"></span></button><a class="navbar-brand" href="https://cocoapods.org"></a></div><div class="collapse navbar-collapse navbar-header-collapse"><ul class="nav navbar-nav navbar-right"><li><a href="https://cocoapods.org/about">About</a></li><li class="active"><a href="https://guides.cocoapods.org">Guides</a></li><li><a href="https://blog.cocoapods.org">Blog</a></li></ul></div></section></nav><section class="container"><div class="row"><header class="col-md-12 headline index"><h1>CocoaPods Guides</h1><div class="horizontal-divider"><div class="arrow-down"></div><div class="enclosed-arrow-down"></div></div></header></div></section><div class="guide" id="content-wrapper"><section class="container"><div class="row"><div class="site_navigation"></div><div class="col-lg-4 col-sm-4 col-xs-12 homepage-index"><h2 class="guide-index"><a href="using/index.html">Using CocoaPods</a></h2><ul><li><h5><a href="using/getting-started.html">Getting Started</a></h5><p>This is a guide for setting up CocoaPods.</p></li><li><h5><a href="using/using-cocoapods.html">Using CocoaPods</a></h5><p>Integration instructions and best practices.</p></li><li><h5><a href="using/pod-install-vs-update.html">pod install vs. pod update</a></h5><p>Explains the difference between pod install and pod update and when to use each</p></li><li><h5><a href="using/the-podfile.html">The Podfile</a></h5><p>Learn all about the Podfile, which is used to declare dependencies for your project.</p></li><li><h5><a href="using/troubleshooting.html">Troubleshooting</a></h5><p>The solutions to common problems.</p></li><li><h5><a href="using/faq.html">F.A.Q</a></h5><p>Is CocoaPods ready for prime-time? Why not just use git submodules? etc. etc.</p></li><li><h5><a href="using/test-specs.html">Testing with CocoaPods</a></h5><p>This is a guide for working with test specifications and CocoaPods</p></li><li><h5><a href="using/a-gemfile.html">Using a Gemfile</a></h5><p>Find out how you can use a Gemfile to version your ruby dependencies</p></li></ul></div><div class="col-lg-4 col-sm-4 col-xs-12 homepage-index"><h2 class="guide-index"><a href="making/index.html">Build with CocoaPods</a></h2><ul><li><h5><a href="making/making-a-cocoapod.html">Making a CocoaPod</a></h5><p>Instructions for creating and maintaining a CocoaPod.</p></li><li><h5><a href="making/using-pod-lib-create.html">Using Pod Lib Create</a></h5><p>The guide for getting a CocoaPod up and running quickly.</p></li><li><h5><a href="making/getting-setup-with-trunk.html">Getting setup with Trunk</a></h5><p>Instructions for creating a CocoaPods user account</p></li><li><h5><a href="making/development-cocoapods.html">Development Pods</a></h5><p>How to reference a local checkout of a Pod's repository while working on modifications to it.</p></li><li><h5><a href="making/private-cocoapods.html">Private Pods</a></h5><p>How to setup a private Podspec repo for maintaining internal libraries.</p></li><li><h5><a href="making/specs-and-specs-repo.html">Specs and the Specs Repo</a></h5><p>Learn about creating Podspec's and the Spec repo.</p></li><div class="clearfix visible-xs"></div></ul></div><div class="col-lg-4 col-sm-4 col-xs-12 homepage-index"><h2 class="guide-index">Reference</h2><ul><li><h5><a href="/syntax/podfile.html">Podfile</a></h5><p>Find out all of the supported attributes of the DSL for downloading Pods.</p></li><li><h5><a href="/syntax/podspec.html">Podspec</a></h5><p>Find out all of the supported attributes of the DSL for creating a library.</p></li><li><h5><a href="/terminal/commands.html">Command Line API</a></h5><p>Find out all of the supported terminal flags and commands.</p></li></ul></div><div class="clearfix"></div><div class="col-lg-12 col-sm-12 col-xs-12"><h2 class="guide-index">CocoaPods Plugins</h2></div><div class="col-lg-12 col-sm-12 col-xs-12"><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="plugins/setting-up-plugins.html">How to use CocoaPods plugins</a></h5><p>Understand how a CocoaPods plugin works and how to use them in your projects</p></div><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="plugins/environment-vars.html">Keeping Secrets</a></h5><p>Using cocoapods-keys to keep secrets out of your source</p></div><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="plugins/optimising-ci-times.html">Optimise CI</a></h5><p>Using cocoapods-check to reduce work on CI</p></div><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="plugins/pre-compiling-dependencies.html">Pre-compiling dependencies</a></h5><p>Using cocoapods-binary to pre-compile a set of your pods</p></div><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="plugins/using-pods-for-closed-source-libs.html">Packaging Closed Source SDKs</a></h5><p>Using cocoapods-packager to ship closed source Pods</p></div></div><div class="clearfix"></div><div class="col-lg-12 col-sm-12 col-xs-12"><h2 class="guide-index">Contributing Back</h2></div><div class="col-lg-12 col-sm-12 col-xs-12"><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="contributing/contribute-to-cocoapods.html">How to Contribute</a></h5><p>CocoaPods is fully open-sourced, so it depends on community contributions to get better. If you're looking to start working on CocoaPods, this is the place to start.</p></div><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="contributing/components.html">Core Components</a></h5><p>These are the core components that make up the CocoaPods gem.</p></div><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="contributing/dev-environment.html">Setting up for Development</a></h5><p>If you're looking to contribute to the CocoaPods project through feature additions or bug fixes, follow these instructions on setting up your development environment.</p></div><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="contributing/release-process.html">Release Process</a></h5><p>This describes how the CocoaPods team deal with the release process.</p></div><div class="col-lg-4 col-sm-4 col-xs-12"><h5><a href="contributing/tickets-handling.html">Ticket handling</a></h5><p>The easiest way to contribute is to help us handling the tickets.</p></div></div></div></section></div><footer class="page-footer"><section class="container"><div class="row"><article class="col-md-8 col-lg-8 col-sm-12 col-md-offset-2 col-lg-offset-2 col-xs-12"><h4>CocoaPods is a project from</h4><p class="contributors"> <a href="https://twitter.com/dnkoutso">Dimitris Koutsogiorgas</a>, <a href="https://dani.builds.terrible.systems/">Danielle Lancashire</a>, <a href="https://github.com/amorde">Eric Amorde</a>, <a href="https://orta.io">Orta Therox</a>, <a href="https://github.com/paulb777">Paul Beusterien</a>, <a href="https://segiddins.me">Samuel Giddins</a>, and <a href="https://cocoapods.org/about#team">The CocoaPods Dev Team</a> with contributions from <a href="https://github.com/CocoaPods/Specs/graphs/contributors">many, many others</a>.</p><h4>Lovingly sponsored by</h4><p class="sponsors"><a href="http://artsy.net">Artsy</a>, <a href="http://www.usebutton.com">Button</a>, <a href="http://www.capitalone.io">Capital One</a>, <a href="https://circleci.com">CircleCI</a>, <a href="http://discontinuity.eu">Discontinuity</a>, <a href="https://www.emergetools.com">Emerge Tools</a>, <a href="http://www.fngtps.com">Fingertips</a>, <a href="https://developers.google.com">Google</a>, <a href="https://www.heroku.com">Heroku</a>, <a href="https://www.jsdelivr.com">jsDelivr</a>, <a href="https://realm.io">Realm</a>, <a href="https://pspdfkit.com/">PSPDFKit</a>, <a href="http://www.rubymotion.com">RubyMotion</a>, <a href="https://www.sauspiel.de">Sauspiel</a>, <a href="https://www.slack.com">Slack</a>, <a href="https://www.soundcloud.com">SoundCloud</a>, <a href="https://www.stripe.com">Stripe</a>, <a href="https://www.squareup.com">Square</a>, and <a href="http://www.technologyastronauts.ch">Technology Astronauts</a>.</p></article></div></section></footer><footer class="footer-links"><section class="container"><div class="row"><article class="col-md-8 col-lg-8 col-sm-12 col-md-offset-2 col-lg-offset-2 col-xs-12"><a class="cocoapods-small-logo" href="https://cocoapods.org"></a><ul><li class="col-md-3 col-sm-3 col-xs-6"><a href="https://guides.cocoapods.org/using/troubleshooting.html">Support</a></li><li class="col-md-3 col-sm-3 col-xs-6"><a href="https://github.com/CocoaPods/CocoaPods">GitHub Repo</a></li><li class="col-md-3 col-sm-3 col-xs-6"><a href="https://status.cocoapods.org">Web Properties Status</a></li><li class="col-md-3 col-sm-3 col-xs-6"><a href="https://twitter.com/CocoaPods">@CocoaPods</a></li><li class="col-md-3 col-sm-3 col-xs-6"><a href="http://groups.google.com/group/cocoapods">Mailing List</a></li><li class="col-md-3 col-sm-3 col-xs-6"><a href="https://cocoapods.org/about"><span class="visible-lg-span">CocoaPods</span> Dev Team</a></li><li class="col-md-3 col-sm-3 col-xs-6"><a href="https://guides.cocoapods.org/syntax/podfile.html">Podfile Doc<span class="hidden-lg-span">s</span><span class="visible-lg-span">umentation</span></a></li><li class="col-md-3 col-sm-3 col-xs-6"><a href="https://cocoapods.org/legal">Legal / Conduct</a></li></ul></article></div></section></footer></body><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-29866548-4', 'cocoapods.org'); ga('send', 'pageview');</script></html>