目录

• 目录
• 简介
• Commands
• Installation
  • pod init
    • Inherited options:
  • pod install
    • Options:
    • Inherited options:
  • pod update
    • Options:
    • Inherited options:
  • pod outdated
    • Options:
    • Inherited options:
  • pod deintegrate
    • Options:
    • Inherited options:
• Environment
  • pod env
    • Inherited options:
• Browse
  • pod search
    • Options:
    • Inherited options:
  • pod list
    • Options:
    • Inherited options:
  • pod try
    • Options:
    • Inherited options:
• Specifications
  • pod spec create
    • Inherited options:
  • pod spec lint
    • Options:
    • Inherited options:
  • pod spec cat
    • Options:
    • Inherited options:
  • pod spec which
    • Options:
    • Inherited options:
  • pod spec edit
    • Options:
    • Inherited options:
• Trunk
  • pod trunk add-owner
    • Inherited options:
  • pod trunk info
    • Inherited options:
  • pod trunk me
    • Inherited options:
  • pod trunk push
    • Options:
    • Inherited options:
  • pod trunk register
    • Options:
    • Inherited options:
  • pod trunk remove-owner
    • Inherited options:
  • pod trunk deprecate
    • Options:
    • Inherited options:
  • pod trunk delete
    • Inherited options:
• Repos
  • pod repo add
    • Options:
    • Inherited options:
  • pod repo add-cdn
    • Inherited options:
  • pod repo update
    • Inherited options:
  • pod repo lint
    • Options:
    • Inherited options:
  • pod repo list
    • Options:
    • Inherited options:
  • pod repo remove
    • Inherited options:
  • pod repo push
    • Options:
    • Inherited options:
  • pod setup
    • Inherited options:
• Libraries
  • pod lib create
    • Options:
    • Inherited options:
  • pod lib lint
    • Options:
    • Inherited options:
• IPC
  • pod ipc repl
    • Options:
    • Inherited options:
  • pod ipc spec
    • Inherited options:
  • pod ipc podfile
    • Options:
      • Inherited options:
  • pod ipc podfile-json
    • Options:
    • Inherited options:
  • pod ipc list
    • Inherited options:
  • pod ipc update-search-index
    • Inherited options:
• Plugins
  • pod plugins list
    • Inherited options:
  • pod plugins search
    • Options:
    • Inherited options:
  • pod plugins installed
    • Inherited options:
  • pod plugins create
    • Inherited options:
  • pod plugins publish
    • Inherited options:
• Cache
  • pod cache list
    • Options:
    • Inherited options:
  • pod cache clean
    • Inherited options:

简介

本文翻译自官方的 Podfile Syntax Reference，若翻译中有什么异议，欢迎留言指正。

Podfile

Podspec

Command Line API

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

• pod init
• pod install
• pod update
• pod outdated
• pod deintegrate

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 /home/travis/.cocoapods/templates folder.

Inherited options:

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:

Inherited options:

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:

Inherited options:

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:

Inherited options:

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:

Inherited options:

Environment

• pod env

pod env

pod env

Display pod environment.

Inherited options:

Browse

• pod search
• pod list
• pod try

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:

Inherited options:

pod list

pod list

Lists all available pods.

Options:

Inherited options:

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:

Inherited options:

Specifications

• pod spec create
• pod spec lint
• pod spec cat
• pod spec which
• pod spec edit

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:

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:

Inherited options:

pod spec cat

pod spec cat [QUERY]

Prints the content of the podspec(s) whose name matches QUERY to standard output.

Options:

Inherited options:

pod spec which

pod spec which [QUERY]

Prints the path of the .podspec file(s) whose name matches QUERY

Options:

Inherited options:

pod spec edit

pod spec edit [QUERY]

Opens the podspec matching QUERY to be edited.

Options:

Inherited options:

Trunk

• pod trunk add-owner
• pod trunk info
• pod trunk me
• pod trunk push
• pod trunk register
• pod trunk remove-owner
• pod trunk deprecate
• pod trunk delete

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:

pod trunk info

Available since v0.33.0.

pod trunk info NAME

Returns information about a Pod.

Inherited options:

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:

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 ‘master’ 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:

Inherited options:

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:

Inherited options:

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:

pod trunk deprecate

Available since v1.0.0.beta.1.

pod trunk deprecate NAME Deprecates a pod.

Options:

Inherited options:

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:

Repos

• pod repo add
• pod repo add-cdn
• pod repo update
• pod repo lint
• pod repo list
• pod repo remove
• pod repo push
• pod setup

pod repo add

pod repo add NAME URL [BRANCH]

Clones URL in the local spec-repos directory at /home/travis/.cocoapods/repos. The remote can later be referred to by NAME.

Options:

Inherited options:

pod repo add-cdn

pod repo add-cdn NAME URL

Add URL to the local spec-repos directory at /home/travis/.cocoapods/repos. The remote can later be referred to by NAME.

Inherited options:

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 /home/travis/.cocoapods/repos.

Inherited options:

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:

Inherited options:

pod repo list

pod repo list

List the repos from the local spec-repos directory at /home/travis/.cocoapods/repos.

Options:

Inherited options:

pod repo remove

pod repo remove NAME

Deletes the remote named NAME from the local spec-repos directory at /home/travis/.cocoapods/repos.

Inherited options:

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 (/home/travis/.cocoapods/repos/[REPO]), copies the podspec file into the version directory, and finally it pushes REPO to its remote.

Options:

Inherited options:

pod setup

pod setup

Creates a directory at /home/travis/.cocoapods/repos 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.

Inherited options:

Libraries

• pod lib create
• pod lib lint

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:

Inherited options:

pod lib lint

pod lib lint [PODSPEC_PATHS ...]

Validates the Pod using the files in the working directory.

Options:

Inherited options:

IPC

• pod ipc repl
• pod ipc spec
• pod ipc podfile
• pod ipc podfile-json
• pod ipc list
• pod ipc update-search-index

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:

Inherited options:

pod ipc spec

pod ipc spec PATH

Converts a podspec to JSON and prints it to STDOUT.

Inherited options:

pod ipc podfile

pod ipc podfile PATH

Converts a Podfile to YAML and prints it to STDOUT.

Options:

Inherited options:

pod ipc podfile-json

pod ipc podfile-json PATH

Converts a Podfile to JSON and prints it to STDOUT.

####Options: | title | desciption | | ——————————— | :——————————————–: | | –project-directory=/project/dir/ | The path to the root of the project directory. |

Inherited options:

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:

###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:

Plugins

• pod plugins list
• pod plugins search
• pod plugins installed
• pod plugins create
• pod plugins publish

###pod plugins list

pod plugins list

List all known plugins (according to the list hosted on github.com/CocoaPods/cocoapods-plugins)

Inherited options:

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:

Inherited options:

pod plugins installed

pod plugins installed

List all installed plugins and their respective version.

Inherited options:

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:

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:

Cache

• pod cache list
• pod cache clean

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:

Inherited options:

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: | title | desciption | | ——— | :————————————: | | –all | Remove all the cached pods without asking. |

Inherited options: