CLI for creating and configuring new Xcode projects
Ruby
1,594
265 commits
updated Jun 27, 2020
Liftoff is a CLI for creating and configuring iOS Xcode projects.
👋 We need your help! We're looking for contributors and people willing to take over Liftoff maintenance. If you're interested, we'd love to hear from you! 👍
brew tap liftoffcli/formulae
brew install liftoff
Liftoff was previously distributed via RubyGems. This method of installation has been deprecated, and all new releases will be done through Homebrew. If you are migrating from RubyGems, you should uninstall the gem version to avoid confusion in the future.
Run this command in a directory
liftoff
View the documentation:
man liftoff
man liftoffrc
When Liftoff finds an existing project in the current directory, it will perform the following configurations:
liftoffrc(5) for a list of the warnings.liftoffrc. See
liftoffrc(5) for more information.git repo and create an initial commit (if needed).When you run Liftoff in a directory without a project file, it will create a new directory structure for a project, and generate a well-configured Xcode project in that subdirectory:
$ cd ~/dev/
$ liftoff
Project name? MyCoolApp
Company name? thoughtbot
Author name? Gordon Fontenot
Prefix? MCA
Creating MyCoolApp
Creating MyCoolApp/Categories
Creating MyCoolApp/Classes
[snip]
Liftoff will generate a brand new project for you based on the provided values. Generating projects via Liftoff has these advantages:
git repository automaticallyYou can use a liftoffrc file to speed up your workflow by defining your
preferred configuration for Liftoff.
Liftoff will look for config files in the local directory and then the home
directory. If it can't find a key in ./.liftoffrc or ~/.liftoffrc, it will
use the default values. Check liftoffrc(5) for more information:
man liftoffrc
You can see the current liftoffrc on master, but be aware that the keys might not match up completely with the current released version.
One of the most powerful things that Liftoff can do for you is let you quickly
and easily customize your project's group and directory structure. By defining
a YAML dictionary inside your local or user .liftoffrc, you can completely
dictate the structure that will be created. This includes group structure,
order, placement of template files, etc. And remember that these groups will
be mimicked on disk as well.
You can also create your own templates, or override the defaults by adding
them to ~/.liftoff/templates or ./.liftoff/templates. Liftoff will use the
same fallback order when looking for templates as it does for the
.liftoffrc.
These files (and filenames) will be parsed with ERB, using the values
provided at run time (or the default values from a liftoffrc).
In Xcode 7.0, there is a bug that when combined with a bug in Liftoff 1.5 results in a crash when trying to launch a project generated by liftoff. This bug is fixed in Liftoff 1.6, but if you have a project created with a version of liftoff <= 1.5, you might experience this crash.
To fix it:
Main.storyboard from the project (only need to remove the
reference, you don't need to trash the file itself)Main.storyboard to the projectYour project should now open cleanly in Xcode 7.0.
See the CONTRIBUTING document. Thank you, contributors!
We'd also love some help for maintaining Liftoff up-to-date on a more regular basis. If you're interested, we'd love to hear from you!
Liftoff is Copyright (c) 2015 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.
Liftoff was originally maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.
1,053 followers · starred May 2014
159 followers · starred Aug 2016
2,537 followers · starred Oct 2012
2,020 followers · starred May 2013
CLI for creating and configuring new Xcode projects
Ruby
1,594
265 commits
updated Jun 27, 2020
Liftoff is a CLI for creating and configuring iOS Xcode projects.
👋 We need your help! We're looking for contributors and people willing to take over Liftoff maintenance. If you're interested, we'd love to hear from you! 👍
brew tap liftoffcli/formulae
brew install liftoff
Liftoff was previously distributed via RubyGems. This method of installation has been deprecated, and all new releases will be done through Homebrew. If you are migrating from RubyGems, you should uninstall the gem version to avoid confusion in the future.
Run this command in a directory
liftoff
View the documentation:
man liftoff
man liftoffrc
When Liftoff finds an existing project in the current directory, it will perform the following configurations:
liftoffrc(5) for a list of the warnings.liftoffrc. See
liftoffrc(5) for more information.git repo and create an initial commit (if needed).When you run Liftoff in a directory without a project file, it will create a new directory structure for a project, and generate a well-configured Xcode project in that subdirectory:
$ cd ~/dev/
$ liftoff
Project name? MyCoolApp
Company name? thoughtbot
Author name? Gordon Fontenot
Prefix? MCA
Creating MyCoolApp
Creating MyCoolApp/Categories
Creating MyCoolApp/Classes
[snip]
Liftoff will generate a brand new project for you based on the provided values. Generating projects via Liftoff has these advantages:
git repository automaticallyYou can use a liftoffrc file to speed up your workflow by defining your
preferred configuration for Liftoff.
Liftoff will look for config files in the local directory and then the home
directory. If it can't find a key in ./.liftoffrc or ~/.liftoffrc, it will
use the default values. Check liftoffrc(5) for more information:
man liftoffrc
You can see the current liftoffrc on master, but be aware that the keys might not match up completely with the current released version.
One of the most powerful things that Liftoff can do for you is let you quickly
and easily customize your project's group and directory structure. By defining
a YAML dictionary inside your local or user .liftoffrc, you can completely
dictate the structure that will be created. This includes group structure,
order, placement of template files, etc. And remember that these groups will
be mimicked on disk as well.
You can also create your own templates, or override the defaults by adding
them to ~/.liftoff/templates or ./.liftoff/templates. Liftoff will use the
same fallback order when looking for templates as it does for the
.liftoffrc.
These files (and filenames) will be parsed with ERB, using the values
provided at run time (or the default values from a liftoffrc).
In Xcode 7.0, there is a bug that when combined with a bug in Liftoff 1.5 results in a crash when trying to launch a project generated by liftoff. This bug is fixed in Liftoff 1.6, but if you have a project created with a version of liftoff <= 1.5, you might experience this crash.
To fix it:
Main.storyboard from the project (only need to remove the
reference, you don't need to trash the file itself)Main.storyboard to the projectYour project should now open cleanly in Xcode 7.0.
See the CONTRIBUTING document. Thank you, contributors!
We'd also love some help for maintaining Liftoff up-to-date on a more regular basis. If you're interested, we'd love to hear from you!
Liftoff is Copyright (c) 2015 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.
Liftoff was originally maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.
1,053 followers · starred May 2014
159 followers · starred Aug 2016
2,537 followers · starred Oct 2012
2,020 followers · starred May 2013