cocoapods

Runs pod install for the project

If you use CocoaPods you can use the cocoapods integration to run pod install before building your app.

cocoapods
Supported platforms ios, mac
Author @KrauseFx, @tadpol, @birmacher, @Liquidsoul

2 Examples

cocoapods
cocoapods(
  clean_install: true,
  podfile: "./CustomPodfile"
)

Parameters

Key Description Default
repo_update Add --repo-update flag to pod install command false
clean_install Execute a full pod installation ignoring the content of the project cache false
silent Execute command without logging output false
verbose Show more debugging information false
ansi Show output with ANSI codes true
use_bundle_exec Use bundle exec when there is a Gemfile presented true
podfile Explicitly specify the path to the Cocoapods' Podfile. You can either set it to the Podfile's path or to the folder containing the Podfile file
error_callback A callback invoked with the command output if there is a non-zero exit status
try_repo_update_on_error Retry with --repo-update if action was finished with error false
deployment Disallow any changes to the Podfile or the Podfile.lock during installation false
allow_root Allows CocoaPods to run as root false
clean DEPRECATED! (Option renamed as clean_install) Remove SCM directories true
integrate DEPRECATED! (Option removed from cocoapods) Integrate the Pods libraries into the Xcode project(s) true

* = default value is dependent on the user's system


Documentation

To show the documentation in your terminal, run

fastlane action cocoapods

CLI

It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run cocoapods

To pass parameters, make use of the : symbol, for example

fastlane run cocoapods parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.


Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub


Back to actions