The project spec is a YAML or JSON file that defines your targets, configurations, schemes and custom build settings. All you source directories are automatically parsed and referenced appropriately while preserving your folder structure. Sensible defaults are used in many places, so you only need to customize what is needed.
- ✅ Easy configuration of projects which is human readable and git friendly
- ✅ Groups in Xcode are always synced to your directories on disk
- ✅ Create projects on demand and remove your
.xcodeprojfile from git, which means no merge conflicts!
- ✅ Easily copy and paste files and directories without having to edit anything in xcode
- ✅ Share build settings across multiple targets with build setting groups
- ✅ Automatically generate Schemes for different environments like test and production
- ✅ Easily create new projects with complicated setups on demand without messing around with Xcode
- ✅ Generate from anywhere including Continuous Delivery servers
- ✅ Distribute your spec amongst multiple files for easy sharing and overriding
Given a very simple project spec file like this:
name: My Project targets: MyApp: type: application platform: iOS sources: MyApp settings: PRODUCT_BUNDLE_IDENTIFIER: com.myapp dependencies: - target: MyFramework MyFramework: type: framework platform: iOS sources: MyFramework
A project would be created with 2 connected targets, with all the required configurations and build settings. See the Project Spec documentation for all the options you can specify.
Make sure Xcode 9 is installed first.
$ mint run yonaskolb/xcodegen
$ git clone https://github.com/yonaskolb/XcodeGen.git $ cd XcodeGen $ make
$ brew tap yonaskolb/XcodeGen https://github.com/yonaskolb/XcodeGen.git $ brew install XcodeGen
Swift Package Manager
Use as CLI
$ git clone https://github.com/yonaskolb/XcodeGen.git $ cd XcodeGen $ swift run
Use as dependency
Add the following to your Package.swift file’s dependencies:
.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "1.0.0"),
And then import wherever needed:
This will look for a project spec in the current directory called
xcodegen --help to see the list of options:
- –spec: An optional path to a
- –project: An optional path to a directory where the project will be generated. By default this is the current directory
$ git clone https://github.com/yonaskolb/XcodeGen.git $ cd XcodeGen $ swift package generate-xcodeproj
This use Swift Project Manager to create an
xcodeproj file that you can open, edit and run in Xcode, which makes editing any code easier.
If you want to pass any required arguments when running in XCode, you can edit the scheme to include launch arguments.
See Project Spec documentation here
This tool is powered by:
Inspiration for this tool came from:
Pull requests and issues are welcome
XcodeGen is licensed under the MIT license. See LICENSE for more info.