xcbuild/README.md
2016-01-26 17:43:36 -08:00

4.2 KiB

xcbuild

xcbuild is an Xcode-compatible build tool with the goal of providing faster builds, better documentation of the build process and running on multiple platforms (in particular OS X and Linux)

Why use xcbuild?

Features Performance
🚀Blazing fast incremential buildsxcodebuildxcbuild + Ninja
📖Documents of the Xcode build process
🔗Builds Xcode projects and workspaces
🐣Supports Swift apps and frameworksClean Build30.103s25.122s
Tools and libraries for Xcode projects
💝Fully compatible with xcpretty
🎩Uses Ninja and llbuildIncremental Build2.190s0.046s
:octocat:Open source under the BSD license
🐧Builds on Linux

xcbuild and other build tools

xctool Buck xcpretty
xcbuild and xctool are both Xcode-compatible build systems. We plan on slowly deprecating xctool's build support but keep it as a great way to run tests. Facebook's main build system is Buck. Buck has a stronger architecture and advanced features like artifact caching while having a much simpler build format. If you have a new project, it's highly recommended. xcbuild works great with xcpretty. Pipe the output from xcbuild to xcpretty the same way as you would from xcodebuild.

Building

git clone https://github.com/facebook/xcbuild
cd xcbuild
git submodule update --init
make

Build output will be in the build directory. Run xcbuild with ./build/xcbuild.

Usage

The command line options are compatible with xcodebuild.

xcbuild -workspace Example.xcworkspace -scheme Release

Using Ninja (or llbuild)

To switch to the significantly faster Ninja executor:

xcbuild -executor ninja [-workspace Example.xcworkspace ...]
Wrote meta-ninja: ~/Library/Developer/Xcode/DerivedData/.../Build/Intermediates/build.ninja

Copy the path to the meta-ninja and run

ninja -f ~/Library/Developer/Xcode/DerivedData/.../Build/Intermediates/build.ninja

Contributing

xcbuild actively welcomes contributions from the community. If you're interested in contributing, be sure to check out the contributing guide. It includes some tips for getting started in the codebase, as well as important information about the code of conduct, license, and CLA.

Thanks

xcbuild is built on build system documentation from the community. In particular, thanks to these people for their writing:

Third-party licenses are listed in the LICENSE document.