Skip to content

Latest commit

 

History

History
129 lines (92 loc) · 7.09 KB

README.md

File metadata and controls

129 lines (92 loc) · 7.09 KB
Raw

fastlane Logo

fastlane

Twitter: @FastlaneTools License Gem Build Status

fastlane is a tool for iOS, Mac, and Android developers to automate tedious tasks like generating screenshots, dealing with provisioning profiles, and releasing your application.

Use a lane to define your process:

lane :beta do
  increment_build_number
  cocoapods
  match
  testflight
  sh "./customScript.sh"
  slack
end

Then to deploy a new 'beta' version of your app just run fastlane beta 🚀

          |  fastlane

--------------------------|------------------------------------------------------------ :sparkles: | Connect iOS, Mac, and Android build tools into one workflow (both fastlane tools and third party tools) :monorail: | Define different deployment lanes for App Store deployment, beta builds, or testing :ship: | Deploy from any computer, including a CI server :wrench: | Extend and customise functionality :thought_balloon: | Never remember any difficult commands, just fastlane 🎩 | Easy setup assistant to get started in a few minutes 📧 | Automatically pass on information from one build step to another (e.g. path to the ipa file) :page_with_curl: | Store everything in Git. Never lookup build commands in Jenkins configs again. :rocket: | Saves you hours for every app update you release :pencil2: | Flexible configuration using a fully customisable Fastfile 🚠 | Implement a fully working Continuous Delivery process 👻 | Jenkins Integration: Show output directly in test results :book: | Automatically generate Markdown documentation of your lane configurations :hatching_chick: | Over 170 built-in integrations available :computer: | Support for iOS, Mac, and Android apps :octocat: | Full Git and Mercurial support

Like this tool? Be the first to know about updates and new fastlane tools.

Installation

sudo gem install fastlane --verbose

Make sure you have the latest version of the Xcode command line tools installed:

xcode-select --install

If you experience slow launch times of fastlane, try running:

gem cleanup

System Requirements: fastlane requires macOS or Linux with Ruby 2.0.0 or above

If you'd like to take a look at a project already using fastlane check out fastlane-examples which includes fastlane setups by Wikipedia, Product Hunt, MindNode, and more.

Quick Start

fastlane's setup assistant creates all the necessary files to get you started, using existing app metadata from iTunes Connect or Google Play.

  • cd [your_project_folder]
  • fastlane init
  • Follow the setup assistant to configure your app
  • Further customise the Ruby based Fastfile with additional actions

For more details, check out the fastlane guide.

Available Commands

Typically you'll use fastlane by triggering individual lanes:

fastlane [lane_name]

Other Commands

  • fastlane actions: List all available fastlane actions
  • fastlane action [action_name]: Shows a more detailed description of an action
  • fastlane lanes: Lists all available lanes with description
  • fastlane list: Lists all available lanes without description
  • fastlane new_action: Create a new action (integration) for fastlane

fastlane Toolchain

In addition to fastlane's commands, you also have access to these fastlane tools:

  • deliver: Upload screenshots, metadata, and your app to the App Store
  • supply: Upload your Android app and its metadata to Google Play
  • snapshot: Automate taking localized screenshots of your iOS app on every device
  • screengrab: Automate taking localized screenshots of your Android app on every device
  • frameit: Quickly put your screenshots into the right device frames
  • pem: Automatically generate and renew your push notification profiles
  • sigh: Because you would rather spend your time building stuff than fighting provisioning
  • produce: Create new iOS apps on iTunes Connect and Dev Portal using the command line
  • cert: Automatically create and maintain iOS code signing certificates
  • spaceship: Ruby library to access the Apple Dev Center and iTunes Connect
  • pilot: The best way to manage your TestFlight testers and builds from your terminal
  • boarding: The easiest way to invite your TestFlight beta testers
  • gym: Building your iOS apps has never been easier
  • match: Easily sync your certificates and profiles across your team using Git
  • scan: The easiest way to run tests for your iOS and Mac apps

Need Help?

Please submit an issue on GitHub and provide information about your setup.

Special Thanks

Thanks to all contributors for extending and improving fastlane.

Code of Conduct

Help us keep fastlane open and inclusive. Please read and follow our Code of Conduct.

License

This project is licensed under the terms of the MIT license. See the LICENSE file.

This project and all fastlane tools are in no way affiliated with Apple Inc or Google. This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. All fastlane tools run on your own computer or server, so your credentials or other sensitive information will never leave your own computer. You are responsible for how you use fastlane tools.