Make sure a certain version of Xcode is installed

The xcode-install gem, which this action depends on, has been sunset. Please migrate to xcodes. You can find a migration guide here: xcpretty/xcode-install/MIGRATION.md

Makes sure a specific version of Xcode is installed. If that's not the case, it will automatically be downloaded by the xcode_install gem. This will make sure to use the correct Xcode for later actions.

Supported platforms ios, mac
Author @Krausefx
Returns The path to the newly installed Xcode version

1 Example

xcode_install(version: "7.1")


Key Description Default
version The version number of the version of Xcode to install
username Your Apple ID Username *
team_id The ID of your team if you're in multiple teams *
download_retry_attempts Number of times the download will be retried in case of failure 3

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

Lane Variables

Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The xcode_install action generates the following Lane Variables:

SharedValue Description
SharedValues::XCODE_INSTALL_XCODE_PATH The path to the newly installed Xcode

To get more information check the Lanes documentation.


To show the documentation in your terminal, run

fastlane action xcode_install


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 xcode_install

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

fastlane run xcode_install 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