Skip to content
ruby wrapper for Xcode build tools to aid automating builds
Ruby Objective-C C++ C
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


A ruby wrapper around various xcode tools and project, schemes and workspace configuration files

Full documentation can be found here:

Example Usage

You will need to install the gem:

gem install xcoder

and then require the gem in your project/rakefile/etc

require 'xcoder'

Load a project

project = Xcode.project('MyProject')  # Can be the name, the file (e.g. MyProject.xcodeproj) or the path

Finding all projects from the current directory down

Xcode.find_projects.each {|p| puts }

Find a configuration for a target on a project

config = Xcode.project(:MyProject).target(:Target).config(:Debug)   # returns an Xcode::Configuration object

Building a configuration

builder = config.builder
builder.profile = 'Profiles/MyAdHoc.mobileprovision'    # This will remove old profiles and install the profile
builder.identity = 'iPhone Developer: Ray Hilton'       # The name of the identity to use to sign the IPA (optional)

Working with Keychains

You will not normally need to worry about manipulating keychains unless you want to automate importing of certificates (in a CI system with many clients) or opening of specific keychains for different builds (the old two-certs-with-same-identity-name workaround).

You can either use the user's login keychain, another named keychain, or simply use a temporary keychain that will be blown away after the build.

Creating a temporary keychain

Xcode::Keychain.temp_keychain('ProjectKeychain.keychain') do |keychain|
    # import certs into the keychain
    # perform builds within this keychain's context
end # Keychain is deleted

Importing a certificate

You can import a certificate from a .p12 file into a keychain. Here we simply create a temporary keychain, import a certificate, set the identity onto the builder and then perform a build.

keychain.import 'Certs/MyCert.p12', 'mycertpassword'        
builder.keychain = keychain                     # Tell the builder to use the temp keychain
builder.identity = keychain.identities.first    # Get the first (only) identity name from the keychain

Packaging a built .app

After performing the above build, you can create a versioned, well named .ipa and


This will produce something like: MyProject-Debug-1.0.ipa and

Incrementing the build number

config.info_plist do |info|
  info.version = info.version.to_i + 1

Working with workspaces

Loading workspaces can be done in a similar way to projects:

Xcode.workspaces.each do |w|
  w.describe                                # prints a recursive description of the 
                                            # structure of the workspace and its projects

Or, if you know the name:

workspace = Xcode.workspace('MyWorkspace')  # Can be the name, the file (e.g. MyWorkspace.xcworkspace) or the path


There is basic support for schemes, you can enumerate them from a project like so:

project.schemes.each do |s|

Or, access them by name:

builder = project.scheme('MyScheme').builder

Note: The builder behaves the same as the builder for the target/config approach and will force xcodebuild to use the local build/ directory (as per xcode3) rather than a generated temporary directory in DerivedData. This may or may not be a good thing.

Note: Shared schemes and user (current logged in user) specific schemes are both loaded. They may share names and other similarities that make them hard to distinguish. Currently the priority loading order is shared schemes and then user specific schemes.

Provisioning profiles

The library provides a mechanism to install/uninstall a provisioning profile. This normally happens as part of a build (if a profile is provided to the builder, see above), but you can do this manually:"Myprofile.mobileprovision").install # installs profile into ~/Library

Or enumerate installed profiles:

Xcode::ProvisioningProfile.installed_profiles.each do |p|
    p.uninstall     # Removes the profile from ~/Library/


The common output of this build/package process is to upload to testflight. This is pretty simple with xcoder:

builder.testflight(API_TOKEN, TEAM_TOKEN) do |tf|
  tf.notes = "some release notes"
  tf.notify = true  # Whether to send a notification to users, default is true
  tf.lists << "AList"  # The lists to distribute the build to

You can also optionally set a .proxy= property or just set the HTTP_PROXY environment variable.

OCUnit to JUnit reports

You can invoke your test target/bundle from the builder

builder.test do |report|
    report.write 'test-reports', :junit

This will invoke the test target, capture the output and write the junit reports to the test-reports directory. Currently only junit is supported.


There are some basic RSpec tests in the project which I suspect /wont/ work on machines without my identity installed.

Currently these tests only assert the basic project file parsing and build code and do not perform file modification tests (e.g. for info plists) or provisioning profile/keychain importing


Please raise issues if you find defects or have a feature request.

Something went wrong with that request. Please try again.