Commands
pod
CocoaPods, the Cocoa library package manager.
Installation
The commands listed in this group provide support for installing and integrating the dependencies 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
Commands
Environment
Trunk
Repos
IPC
pod init
pod init XCODEPROJ
Creates a Podfile for the current directory if none currently exists. If
an XCODEPROJ project file is specified or if there is only a single
project file in the current directory, targets will be automatically
generated based on targets defined in the project.
It is possible to specify a list of dependencies which will be used by
the template in the Podfile.default (normal targets) Podfile.test
(test targets) files which should be stored in the
/Users/eamorde/.cocoapods/templates folder.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod install
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:
project `path/to/XcodeProject.xcodeproj`
If no project 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.
This may return one of several error codes if it encounters problems.
* 1 Generic error code
* 31 Spec not found (i.e out-of-date source repos, mistyped Pod name etc...)
Options:
--repo-update | Force running |
--deployment | Disallow any changes to the Podfile or the Podfile.lock during installation. |
--clean-install | Ignore the contents of the project cache and force a full pod installation. This only applies to projects that have enabled incremental installation. |
--project-directory=/project/dir/ | The path to the root of the project directory. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod update
pod update [POD_NAMES ...]
Updates the Pods identified by the specified POD_NAMES, which is a
space-delimited list of pod names. If no POD_NAMES are specified, it
updates all the Pods, ignoring the contents of the Podfile.lock. This
command is reserved for the update of dependencies; pod install should
be used to install changes to the Podfile.
Options:
--sources=https://cdn.cocoapods.org/ | The sources from which to update dependent pods. Multiple sources must be comma-delimited. |
--exclude-pods=podName | Pods to exclude during update. Multiple pods must be comma-delimited. |
--clean-install | Ignore the contents of the project cache and force a full pod installation. This only applies to projects that have enabled incremental installation. |
--project-directory=/project/dir/ | The path to the root of the project directory. |
--no-repo-update | Skip running |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod outdated
pod outdated
Shows the outdated pods in the current Podfile.lock, but only those from spec repos, not those from local/external sources.
Options:
--ignore-prerelease | Don't consider prerelease versions to be updates. |
--project-directory=/project/dir/ | The path to the root of the project directory. |
--no-repo-update | Skip running |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod deintegrate
Available since v1.0.0.beta.1.
pod deintegrate [XCODE_PROJECT]
Deintegrate your project from CocoaPods. Removing all traces of CocoaPods from your Xcode project.
If no xcodeproj is specified, then a search for an Xcode project will be made in the current directory.
Options:
--project-directory=/project/dir/ | The path to the root of the project directory. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod env
pod env
Display pod environment.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod search
Available since v0.0.2.
pod search QUERY
Searches for pods, ignoring case, whose name, summary, description, or authors match QUERY. If the
--simple option is specified, this will only search in the names of the pods.
Options:
--regex | Interpret the |
--simple | Search only by name. |
--stats | Show additional stats (like GitHub watchers and forks). |
--web | Searches on cocoapods.org. |
--ios | Restricts the search to Pods supported on iOS. |
--osx | Restricts the search to Pods supported on macOS. |
--watchos | Restricts the search to Pods supported on watchOS. |
--visionos | Restricts the search to Pods supported on visionOS. |
--tvos | Restricts the search to Pods supported on tvOS. |
--no-pager | Do not pipe search results into a pager. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod list
pod list
Lists all available pods.
Options:
--update | Run |
--stats | Show additional stats (like GitHub watchers and forks). |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod try
Available since v0.29.0.
pod try NAME|URL
Downloads the Pod with the given NAME (or Git URL), install its
dependencies if needed and opens its demo project. If a Git URL is
provided the head of the repo is used.
If a Git URL is specified, then a --podspec_name can be provided, if the podspec name is different than the git repo for some reason.
Options:
--podspec_name=[name] | The name of the podspec file within the Git Repository. |
--no-repo-update | Skip running |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod spec create
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.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod spec lint
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.
Options:
--quick | Lint skips checks that would require to download and build the spec. |
--allow-warnings | Lint validates even if warnings are present. |
--subspec=NAME | Lint validates only the given subspec. |
--no-subspecs | Lint skips validation of subspecs. |
--no-clean | Lint leaves the build directory intact for inspection. |
--fail-fast | Lint stops on the first failing platform or subspec. |
--use-libraries | Lint uses static libraries to install the spec. |
--use-modular-headers | Lint uses modular headers during installation. |
--use-static-frameworks | Lint uses static frameworks during installation. |
--sources=https://cdn.cocoapods.org/ | The sources from which to pull dependent pods (defaults to https://cdn.cocoapods.org/). Multiple sources must be comma-delimited. |
--platforms=ios,macos | Lint against specific platforms (defaults to all platforms supported by the podspec). Multiple platforms must be comma-delimited. |
--private | Lint skips checks that apply only to public specs. |
--swift-version=VERSION | The |
--skip-import-validation | Lint skips validating that the pod can be imported. |
--skip-tests | Lint skips building and running tests during validation. |
--test-specs=test-spec1,test-spec2,etc | List of test specs to run. |
--analyze | Validate with the Xcode Static Analysis tool. |
--configuration=CONFIGURATION | Build using the given configuration (defaults to Release). |
--validation-dir | The directory to use for validation. If none is specified a temporary directory will be used.. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod spec cat
pod spec cat [QUERY]
Prints the content of the podspec(s) whose name matches QUERY to standard output.
Options:
--regex | Interpret the |
--show-all | Pick from all versions of the given podspec. |
--version | Print a specific version of the given podspec. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod spec which
pod spec which [QUERY]
Prints the path of the .podspec file(s) whose name matches QUERY
Options:
--regex | Interpret the |
--show-all | Print all versions of the given podspec. |
--version | Print a specific version of the given podspec. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod spec edit
pod spec edit [QUERY]
Opens the podspec matching QUERY to be edited.
Options:
--regex | Interpret the |
--show-all | Pick from all versions of the given podspec. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod trunk add-owner
Available since v0.33.0.
pod trunk add-owner POD OWNER-EMAIL
Adds the registered user with specified OWNER-EMAIL as an owner
of the given POD.
An ‘owner’ is a registered user whom is allowed to make changes to a
pod, such as pushing new versions and adding and removing other ‘owners’.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod trunk info
Available since v0.33.0.
pod trunk info NAME
Returns information about a Pod.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod trunk me
Available since v0.33.0.
pod trunk me
Includes information about your registration, followed by all your sessions.
These are your current session, other valid sessions, unverified sessions, and expired sessions.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod trunk push
Available since v0.33.0.
pod trunk push [PATH]
Publish the podspec at PATH to make it available to all users of
the ‘trunk’ spec-repo. If PATH is not provided, defaults to the
current directory.
Before pushing the podspec to cocoapods.org, this will perform a local lint of the podspec, including a build of the library. However, it remains your responsibility to ensure that the published podspec will actually work for your users. Thus it is recommended that you first try to use the podspec to integrate the library into your demo and/or real application.
If this is the first time you publish a spec for this pod, you will automatically be registered as the ‘owner’ of this pod. (Note that ‘owner’ in this case implies a person that is allowed to publish new versions and add other ‘owners’, not necessarily the library author.)
Options:
--allow-warnings | Allows push even if there are lint warnings. |
--use-libraries | Linter uses static libraries to install the spec. |
--use-modular-headers | Lint uses modular headers during installation. |
--swift-version=VERSION | The SWIFT_VERSION that should be used to lint the spec. This takes precedence over a .swift-version file.. |
--skip-import-validation | Lint skips validating that the pod can be imported. |
--skip-tests | Lint skips building and running tests during validation. |
--synchronous | If validation depends on other recently pushed pods, synchronize. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod trunk register
Available since v0.33.0.
pod trunk register EMAIL [YOUR_NAME]
Register a new account, or create a new session.
If this is your first registration, both an EMAIL address and
YOUR_NAME are required. If you’ve already registered with trunk, you may
omit the YOUR_NAME (unless you would like to change it).
It is recommended that you provide a description of the session, so that it will be easier to identify later on. For instance, when you would like to clean-up your sessions. A common example is to specify the location where the machine, that you are using the session for, is physically located.
Examples:
$ 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
Options:
--description=DESCRIPTION | An arbitrary description to easily identify your session later on.. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod trunk remove-owner
Available since v0.33.0.
pod trunk remove-owner POD OWNER-EMAIL
Removes the user with specified OWNER-EMAIL from being an owner
of the given POD.
An ‘owner’ is a registered user whom is allowed to make changes to a
pod, such as pushing new versions and adding and removing other ‘owners’.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod trunk deprecate
Available since v1.0.0.beta.1.
pod trunk deprecate NAME
Deprecates a pod.
Options:
--in-favor-of=OTHER_NAME | The pod to deprecate this pod in favor of.. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod trunk delete
Available since v1.0.0.beta.1.
pod trunk delete NAME VERSION
WARNING: It is generally considered bad behavior to remove versions of a Pod that others are depending on! Please consider using the deprecate command instead.
Deletes the specified pod version from trunk and the master specs repo. Once deleted, this version can never be pushed again.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod repo add
pod repo add NAME URL [BRANCH]
Clones URL in the local spec-repos directory at /Users/eamorde/.cocoapods/repos. The
remote can later be referred to by NAME.
Options:
--progress | Show the progress of cloning the spec repository. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod repo add-cdn
pod repo add-cdn NAME URL
Add URL to the local spec-repos directory at /Users/eamorde/.cocoapods/repos. The
remote can later be referred to by NAME.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod repo update
pod repo update [NAME]
Updates the local clone of the spec-repo NAME. If NAME is omitted
this will update all spec-repos in /Users/eamorde/.cocoapods/repos.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod repo lint
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.
Options:
--only-errors | Lint presents only the errors. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod repo list
pod repo list
List the repos from the local spec-repos directory at /Users/eamorde/.cocoapods/repos.
Options:
--count-only | Show the total number of repos. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod repo remove
pod repo remove NAME
Deletes the remote named NAME from the local spec-repos directory at /Users/eamorde/.cocoapods/repos.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod repo push
pod repo 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 (/Users/eamorde/.cocoapods/repos/[REPO]), copies the podspec file into the
version directory, and finally it pushes REPO to its remote.
Options:
--allow-warnings | Allows pushing even if there are warnings. |
--use-libraries | Linter uses static libraries to install the spec. |
--use-modular-headers | Lint uses modular headers during installation. |
--sources=https://cdn.cocoapods.org/ | The sources from which to pull dependent pods (defaults to all available repos). Multiple sources must be comma-delimited. |
--local-only | Does not perform the step of pushing REPO to its remote. |
--no-private | Lint includes checks that apply only to public repos. |
--skip-import-validation | Lint skips validating that the pod can be imported. |
--skip-tests | Lint skips building and running tests during validation. |
--commit-message="Fix bug in pod" | Add custom commit message. Opens default editor if no commit message is specified. |
--use-json | Convert the podspec to JSON before pushing it to the repo. |
--swift-version=VERSION | The |
--no-overwrite | Disallow pushing that would overwrite an existing spec. |
--update-sources | Make sure sources are up-to-date before a push. |
--validation-dir | The directory to use for validation. If none is specified a temporary directory will be used.. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod setup
pod setup
Set up the CocoaPods environment
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--version | Show the version of the tool. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod lib create
pod lib create NAME
Creates a scaffold for the development of a new Pod named NAME
according to the CocoaPods best practices.
If a TEMPLATE_URL, pointing to a git repo containing a compatible
template, is specified, it will be used in place of the default one.
Options:
--template-url=URL | The URL of the git repo containing a compatible template. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod lib lint
pod lib lint [PODSPEC_PATHS ...]
Validates the Pod using the files in the working directory.
Options:
--quick | Lint skips checks that would require to download and build the spec. |
--allow-warnings | Lint validates even if warnings are present. |
--subspec=NAME | Lint validates only the given subspec. |
--no-subspecs | Lint skips validation of subspecs. |
--no-clean | Lint leaves the build directory intact for inspection. |
--fail-fast | Lint stops on the first failing platform or subspec. |
--use-libraries | Lint uses static libraries to install the spec. |
--use-modular-headers | Lint uses modular headers during installation. |
--use-static-frameworks | Lint uses static frameworks during installation. |
--sources=https://cdn.cocoapods.org/ | The sources from which to pull dependent pods (defaults to https://cdn.cocoapods.org/). Multiple sources must be comma-delimited. |
--platforms=ios,macos,visionos | Lint against specific platforms (defaults to all platforms supported by the podspec). Multiple platforms must be comma-delimited. |
--private | Lint skips checks that apply only to public specs. |
--swift-version=VERSION | The |
--include-podspecs=**/*.podspec | Additional ancillary podspecs which are used for linting via :path. |
--external-podspecs=**/*.podspec | Additional ancillary podspecs which are used for linting via :podspec. If there are --include-podspecs, then these are removed from them. |
--skip-import-validation | Lint skips validating that the pod can be imported. |
--skip-tests | Lint skips building and running tests during validation. |
--test-specs=test-spec1,test-spec2,etc | List of test specs to run. |
--analyze | Validate with the Xcode Static Analysis tool. |
--configuration=CONFIGURATION | Build using the given configuration (defaults to Release). |
--validation-dir | The directory to use for validation. If none is specified a temporary directory will be used.. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod ipc repl
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.
Options:
--project-directory=/project/dir/ | The path to the root of the project directory. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod ipc spec
pod ipc spec PATH
Converts a podspec to JSON and prints it to STDOUT.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod ipc podfile
pod ipc podfile PATH
Converts a Podfile to YAML and prints it to STDOUT.
Options:
--project-directory=/project/dir/ | The path to the root of the project directory. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod ipc podfile-json
pod ipc podfile-json PATH
Converts a Podfile to JSON and prints it to STDOUT.
Options:
--project-directory=/project/dir/ | The path to the root of the project directory. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod ipc list
pod ipc list
Prints to STDOUT a YAML dictionary where the keys are the name of the specifications and each corresponding value is a dictionary with the following keys: - defined_in_file - version - authors - summary - description - platforms
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod ipc update-search-index
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: - version - summary - description - authors
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod plugins list
pod plugins list
List all known plugins (according to the list hosted on github.com/CocoaPods/cocoapods-plugins)
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod plugins search
pod plugins search QUERY
Searches plugins whose name contains the given QUERY.
QUERY is a regular expression, ignoring case.
With --full, it also searches by author and description.
Options:
--full | Search by name, author, and description. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod plugins installed
pod plugins installed
List all installed plugins and their respective version.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod plugins create
pod plugins create NAME [TEMPLATE_URL]
Creates a scaffold for the development of a new plugin
named NAME according to the CocoaPods best practices.
If a TEMPLATE_URL, pointing to a git repo containing a
compatible template, is specified, it will be used
in place of the default one.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod plugins publish
pod plugins publish
This command is only useful for developers of CocoaPods plugins.
It opens a new GitHub issue to request adding the plugin currently being developped to the list of official plugins.
The current directory is expected to have one (and only one)
.gemspec file describing the CocoaPods plugin gem.
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod cache list
pod cache list [NAME]
Shows the content of the pods cache as a YAML tree output, organized by pod.
If NAME is given, only the caches for that pod will be included in the output.
Options:
--short | Only print the path relative to the cache root. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |
pod cache clean
pod cache clean [NAME]
Remove the cache for a given pod, or clear the cache completely.
If there is multiple cache for various versions of the requested pod,
you will be asked which one to clean. Use --all to clean them all.
If you do not give a pod NAME, you need to specify the --all
flag (this is to avoid cleaning all the cache by mistake).
Options:
--all | Remove all the cached pods without asking. |
Inherited options:
--allow-root | Allows CocoaPods to run as root. |
--silent | Show nothing. |
--verbose | Show more debugging information. |
--no-ansi | Show output without ANSI codes. |
--help | Show help banner of specified command. |