pod
CocoaPods, the Objective-C library package manager.
The commands listed in this group provide support for installing and integrating the dependecies specified in a Podfile.
Following is presented the basic workflow for integrating CocoaPods in a user project.
$ touch Podfile $ vim Podfile $ pod install
$ open *.xcworkspace
$ vim podfile $ pod install
$ pod outdated
$ pod update
pod install
Downloads all dependencies defined in Podfile
and creates an Xcode
Pods library project in ./Pods
.
The Xcode project file should be specified in your Podfile
like this:
xcodeproj path/to/XcodeProject
If no xcodeproj is specified, then a search for an Xcode project will be made. If more than one Xcode project is found, the command will raise an error.
This will configure the project to reference the Pods static library, add a build configuration file, and add a post build script to copy Pod resources.
--no-clean
Leave SCM dirs like .git' and
.svn' intact after downloading.
--no-integrate
Skip integration of the Pods libraries in the Xcode project(s).
--no-repo-update
Skip running pod repo update
before install.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod update
Update outdated project dependencies
--no-clean
Leave SCM dirs like .git' and
.svn' intact after downloading.
--no-integrate
Skip integration of the Pods libraries in the Xcode project(s).
--no-repo-update
Skip running pod repo update
before install.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod outdated
Shows the outdated pods in the current Podfile.lock, but only those from
spec repos, not those from local/external sources or :head
versions.
--no-repo-update
Skip running pod repo update
before install.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod help [COMMAND]
Show help for the given command.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod search [QUERY]
Searches for pods, ignoring case, whose name matches QUERY
. If the
--full
option is specified, this will also search in the summary and
description of the pods.
--full
Search by name, summary, and description.
--stats
Show additional stats (like GitHub watchers and forks).
--ios
Restricts the search to Pods supported on iOS.
--osx
Restricts the search to Pods supported on OS X.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod list
Lists all available pods.
--update
Run pod repo update
before listing.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod list new
Lists pods introduced in the master spec-repo since the last check
--update
Run pod repo update
before listing.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod podfile-info [PODFILE_PATH]
Shows information on installed Pods in current Project.
If optional PODFILE_PATH
provided, the info will be shown for
that specific Podfile
--all
Show information about all Pods with dependencies that are used in a project.
--md
Output information in Markdown format.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod spec create [ NAME | https://github.com/USER/REPO ]
Creates a PodSpec, in the current working dir, called NAME.podspec
.
If a GitHub url is passed the spec is prepopulated.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod spec lint [ NAME.podspec | DIRECTORY | http://PATH/NAME.podspec, ... ]
Validates NAME.podspec
. If a directory is provided it validates
the podspec files found, including subfolders. In case
the argument is omitted, it defaults to the current working dir.
--quick
Lint skips checks that would require to download and build the spec.
--only-errors
Lint validates even if warnings are present.
--no-clean
Lint leaves the build directory intact for inspection.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod spec cat [ NAME ]
Prints NAME.podspec
to standard output.
--show-all
Pick from all versions of the given podspec.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod spec which [ NAME ]
Prints the path of NAME.podspec
--show-all
Print all versions of the given podspec.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod spec edit [ NAME ]
Opens NAME.podspec
to be edited.
--show-all
Pick which spec to edit from all available versions of the given podspec.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod push REPO [NAME.podspec]
Validates NAME.podspec or *.podspec
in the current working dir, creates
a directory and version folder for the pod in the local copy of
REPO (~/.cocoapods/repos/[REPO]), copies the podspec file into the version
directory, and finally it pushes REPO to its remote.
--allow-warnings
Allows pushing even if there are warnings.
--local-only
Does not perform the step of pushing REPO to its remote.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod repo add NAME URL [BRANCH]
Clones URL
in the local spec-repos directory at ~/.cocoapods/repos/
. The
remote can later be referred to by NAME
.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod repo update [NAME]
Updates the local clone of the spec-repo NAME
. If NAME
is omitted
this will update all spec-repos in ~/.cocoapods/repos
.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod repo lint [ NAME | DIRECTORY ]
Lints the spec-repo NAME
. If a directory is provided it is assumed
to be the root of a repo. Finally, if NAME
is not provided this
will lint all the spec-repos known to CocoaPods.
--only-errors
Lint presents only the errors.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod setup
Creates a directory at ~/.cocoapods
which will hold your spec-repos.
This is where it will create a clone of the public master
spec-repo from:
https://github.com/CocoaPods/Specs
If the clone already exists, it will ensure that it is up-to-date.
--push
Use this option to enable push access once granted.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod lib create [NAME]
Creates a new Pod with the given name from the template in the working directory.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod lib lint
Validates the Pod using the files in the working directory.
--quick
Lint skips checks that would require to download and build the spec.
--only-errors
Lint validates even if warnings are present.
--no-clean
Lint leaves the build directory intact for inspection.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod ipc repl
The repl listens to commands on standard input and prints their result to standard output.
It accepts all the other ipc subcommands. The repl will signal the
end of output with the the ASCII CR+LF \n\r
.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod ipc spec PATH
Converts a podspec to YAML and prints it to STDOUT.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod ipc podfile PATH
Converts a Podfile to YAML and prints it to STDOUT.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod ipc list
Prints to STDOUT a YAML dictionary where the keys are the name of the specifications and the values are a dictionary with the following keys.
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.
pod ipc update-search-index
Updates the search index and prints its path to standard output. The search index is a YAML encoded dictionary where the keys are the names of the Pods and the values are a dictionary containing the following information:
--silent
Show nothing.
--version
Show the version of CocoaPods.
--no-color
Show output without color.
--verbose
Show more debugging information.
--help
Show help banner of specified command.