yonaskolb/xcodegen

XcodeGen is a command line tool written in Swift that generates your Xcode project using your folder structure and a project spec.

Installing

Make sure the latest stable (non-beta) version of Xcode is installed first.

Mint

mint install yonaskolb/xcodegen

Make

git clone https://github.com/yonaskolb/XcodeGen.git
cd XcodeGen
make install

Homebrew

brew install xcodegen

Swift Package Manager

Use as CLI

git clone https://github.com/yonaskolb/XcodeGen.git
cd XcodeGen
swift run xcodegen

Use as dependency

Add the following to your Package.swift file's dependencies:

.package(url: "https://github.com/yonaskolb/XcodeGen.git", from: "2.45.4"),

And then import wherever needed: import XcodeGenKit

Usage

Simply run:

xcodegen generate

This will look for a project spec in the current directory called project.yml and generate an Xcode project with the name defined in the spec.

Options:

--spec: An optional path to a .yml or .json project spec. Defaults to project.yml. (It is also possible to link to multiple spec files by comma separating them. Note that all other flags will be the same.)
--project: An optional path to a directory where the project will be generated. By default this is the directory the spec lives in.
--quiet: Suppress informational and success messages.
--use-cache: Used to prevent unnecessarily generating the project. If this is set, then a cache file will be written to when a project is generated. If xcodegen is later run but the spec and all the files it contains are the same, the project won't be generated.
--cache-path: A custom path to use for your cache file. This defaults to ~/.xcodegen/cache/{PROJECT_SPEC_PATH_HASH}

There are other commands as well such as xcodegen dump which lets one output the resolved spec in many different formats, or write it to a file. Use xcodegen help to see more detailed usage information.

Editing

git clone https://github.com/yonaskolb/XcodeGen.git
cd XcodeGen
swift package generate-xcodeproj

This uses Swift Package 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.

Documentation

See Project Spec documentation for all the various properties and options that can be set
See Usage for more specific usage and use case documentation
See FAQ for a list of some frequently asked questions
See Examples for some real world XcodeGen project specs out in the wild

Alternatives

If XcodeGen doesn't meet your needs try these great alternatives:

Attributions

This tool is powered by:

Inspiration for this tool came from:

Contributions

Pull requests and issues are always welcome. Please open any issues and PRs for bugs, features, or documentation.

License

XcodeGen is licensed under the MIT license. See LICENSE for more info.

Package Metadata

Repository: yonaskolb/xcodegen

Default branch: master

README: README.md