fastlane

https://docs.fastlane.tools
Admin
fastlane is an open-source automation tool that simplifies beta deployments and releases for iOS and...
Tokens:688,302
Snippets:5,095
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### install_on_device action example

Source: https://docs.fastlane.tools/actions/install_on_device

Installs the ipa on the device. If no id is given, the first found iOS device will be used. Works via USB or Wi-Fi. This requires `ios-deploy` to be installed. To quickly install it, use `brew install ios-deploy`.

```ruby
install_on_device(
  device_id: "a3be6c9ff7e5c3c6028597513243b0f933b876d4",
  ipa: "./app.ipa"
)

```

--------------------------------

### Swift: Setup snapshot in setUp()

Source: https://docs.fastlane.tools/actions/capture_screenshots

Add this code to your setUp() method to initialize the XCUIApplication and snapshot helper before launching the app. Ensure only one launch call exists in your test class.

```swift
let app = XCUIApplication()
setupSnapshot(app)
app.launch()

```

--------------------------------

### xcode_install action example

Source: https://docs.fastlane.tools/actions/xcode_install

Installs a specific version of Xcode using the xcode_install action. The version parameter specifies the Xcode version to install.

```ruby
xcode_install(version: "7.1")

```

--------------------------------

### xcode_select example

Source: https://docs.fastlane.tools/actions/xcode_select

Selects the Xcode installation at the provided path. Useful for beta versions of Xcode.

```ruby
xcode_select("/Applications/Xcode-8.3.2.app")
```

--------------------------------

### Objective C: Setup snapshot in setUp()

Source: https://docs.fastlane.tools/actions/capture_screenshots

Add this code to your setUp() method to initialize the XCUIApplication and snapshot helper before launching the app. Ensure only one launch call exists in your test class.

```objective-c
XCUIApplication *app = [[XCUIApplication alloc] init];
[Snapshot setupSnapshot:app waitForAnimations:NO];
[app launch];

```

--------------------------------

### Snapfile configuration example

Source: https://docs.fastlane.tools/actions/capture_ios_screenshots

Example Snapfile that sets scheme, devices, languages, and launch arguments for snapshot.

```ruby
scheme("UITests")

devices([
  "iPad (7th generation)",
  "iPad Air (3rd generation)",
  "iPad Pro (11-inch)",
  "iPad Pro (12.9-inch) (3rd generation)",
  "iPad Pro (9.7-inch)",
  "iPhone 11",
  "iPhone 11 Pro",
  "iPhone 11 Pro Max",
  "iPhone 8",
  "iPhone 8 Plus"
])

languages([
  "en-US",
  "de-DE",
  "es-ES",
  ["pt", "pt_BR"] # Portuguese with Brazilian locale
])

launch_arguments(["-username Felix"])
```

--------------------------------

### Minimal build_app Fastfile example

Source: https://docs.fastlane.tools/actions/build_ios_app

Minimal example of the `build_app` action with scheme and workspace parameters.

```ruby
build_app(scheme: "MyApp", workspace: "MyApp.xcworkspace")
```

--------------------------------

### Install plugins on another machine

Source: https://docs.fastlane.tools/plugins/using-plugins

Run this command to install all plugins on the local machine.

```bash
fastlane install_plugins
```

--------------------------------

### Start Jenkins LTS service

Source: https://docs.fastlane.tools/best-practices/continuous-integration/jenkins

Starts the Jenkins LTS service after installation. Use this command to launch Jenkins as a background service on macOS.

```bash
brew services start jenkins-lts

```

--------------------------------

### Show documentation for setup_jenkins

Source: https://docs.fastlane.tools/actions/setup_jenkins

Run this command in your terminal to display the action's documentation.

```bash
fastlane action setup_jenkins

```

--------------------------------

### Start private lane production

Source: https://docs.fastlane.tools/advanced/lanes

Starts a private lane definition named `production`. The example is incomplete in the source, showing only the opening line.

```ruby
lane :production do
```

--------------------------------

### installr action example

Source: https://docs.fastlane.tools/actions/installr

Uploads a build to Installr with an API token, IPA file, release notes, and group notifications.

```ruby
installr(
  api_token: "...",
  ipa: "test.ipa",
  notes: "The next great version of the app!",
  notify: "dev,qa",
  add: "exec,ops"
)

```

--------------------------------

### Show bundle_install documentation

Source: https://docs.fastlane.tools/actions/bundle_install

Displays the documentation for the bundle_install action in the terminal.

```shell
fastlane action bundle_install
```

--------------------------------

### Activate screen for testing

Source: https://docs.fastlane.tools/getting-started/android/screenshots

Use this in your test setup if you're having trouble getting your device unlocked and the screen activated to run tests.

```java
ScreenUtil.activateScreenForTesting(activity);
```

--------------------------------

### Output of pilot builds

Source: https://docs.fastlane.tools/actions/upload_to_testflight

Example output of the `fastlane pilot builds` command, showing a table of builds with version, build number, and installs.

```text
+-----------+---------+----------+
|      Great App Builds          |
+-----------+---------+----------+
| Version # | Build # | Installs |
+-----------+---------+----------+
| 0.9.13    | 1       | 0        |
| 0.9.13    | 2       | 0        |
| 0.9.20    | 3       | 0        |
| 0.9.20    | 4       | 3        |
+-----------+---------+----------+

```

--------------------------------

### Example Gymfile

Source: https://docs.fastlane.tools/actions/build_ios_app

A sample Gymfile configuration with scheme, sdk, clean, output_directory, and output_name.

```ruby
scheme("Example")

sdk("iphoneos9.0")

clean(true)

output_directory("./build")    # store the ipa in this folder
output_name("MyApp")           # the name of the ipa file

```

--------------------------------

### Full build_app Fastfile example

Source: https://docs.fastlane.tools/actions/build_ios_app

Full example of the `build_app` action with common parameters. Defaults for `output_directory` is current directory. `clean` defaults to `false` and `silent` to `false`.

```ruby
build_app(
  workspace: "MyApp.xcworkspace",
  configuration: "Debug",
  scheme: "MyApp",
  silent: true,
  clean: true,
  output_directory: "path/to/dir", # Destination directory. Defaults to current directory.
  output_name: "my-app.ipa",       # specify the name of the .ipa file to generate (including file extension)
  sdk: "iOS 11.1"        # use SDK as the name or path of the base SDK when building the project.
)
```

--------------------------------

### default_platform example

Source: https://docs.fastlane.tools/actions/default_platform

Sets the default platform to avoid specifying the platform in subsequent actions. Use this at the start of your Fastfile to define a default platform.

```ruby
default_platform(:android)

```

--------------------------------

### Install fastlane with Homebrew

Source: https://docs.fastlane.tools/

Installs fastlane via Homebrew on macOS. Homebrew installs the adequate Ruby version for fastlane, so you don't have to install Ruby separately.

```bash
brew install fastlane
```

--------------------------------

### bundle_install

Source: https://docs.fastlane.tools/actions/bundle_install

Runs `bundle install` (if available) to install gem dependencies. Supports various options to customize the installation behavior.

```APIDOC
## bundle_install

### Description
Runs `bundle install` (if available) to install gem dependencies.

### Parameters

| Key | Description | Default |
|-----|-------------|---------|
| `binstubs` | Generate bin stubs for bundled gems to ./bin | |
| `clean` | Run bundle clean automatically after install | `false` |
| `full_index` | Use the rubygems modern index instead of the API endpoint | `false` |
| `gemfile` | Use the specified gemfile instead of Gemfile | |
| `jobs` | Install gems using parallel workers | |
| `local` | Do not attempt to fetch gems remotely and use the gem cache instead | `false` |
| `deployment` | Install using defaults tuned for deployment and CI environments | `false` |
| `no_cache` | Don't update the existing gem cache | `false` |
| `no_prune` | Don't remove stale gems from the cache | `false` |
| `path` | Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME). Bundler will remember this value for future installs on this machine | |
| `system` | Install to the system location ($BUNDLE_PATH or $GEM_HOME) even if the bundle was previously installed somewhere else for this application | `false` |
| `quiet` | Only output warnings and errors | `false` |
| `retry` | Retry network and git requests that have failed | |
| `shebang` | Specify a different shebang executable name than the default (usually 'ruby') | |
| `standalone` | Make a bundle that can work without the Bundler runtime | |
| `trust_policy` | Sets level of security when dealing with signed gems. Accepts `LowSecurity`, `MediumSecurity` and `HighSecurity` as values | |
| `without` | Exclude gems that are part of the specified named group | |
| `with` | Include gems that are part of the specified named group | |
| `frozen` | Don't allow the Gemfile.lock to be updated after install | `false` |
| `redownload` | Force download every gem, even if the required versions are already available locally | `false` |

### CLI Usage

To run this action from the command line, use:

```
fastlane run bundle_install
```

To pass parameters, use the `:` symbol:

```
fastlane run bundle_install parameter1:"value1" parameter2:"value2"
```

Note: The CLI supports primitive types (integers, floats, booleans, strings) and comma-delimited arrays. Hashes are not supported.

### Source Code

This action is open source. View the source code on GitHub.
```

--------------------------------

### Show setup_circle_ci documentation in terminal

Source: https://docs.fastlane.tools/actions/setup_circle_ci

Run this command to display the action documentation in your terminal.

```bash
fastlane action setup_circle_ci

```

--------------------------------

### tryouts action example

Source: https://docs.fastlane.tools/actions/tryouts

Uploads a new build to Tryouts using the tryouts action. The example shows the required api_token, app_id, and build_file parameters. The build_file parameter is optional if you use the _gym_ or _xcodebuild_ action.

```ruby
tryouts(
  api_token: "...",
  app_id: "application-id",
  build_file: "test.ipa",
)

```

--------------------------------

### Install specific bundler version and run fastlane

Source: https://docs.fastlane.tools/best-practices/continuous-integration/codemagic

Installs bundler version 2.2.27 as defined in Gemfile.lock, then installs dependencies and runs the fastlane lane.

```yaml
scripts:
  - gem install bundler:2.2.27
  - bundle install
  - bundle exec fastlane beta      

```

--------------------------------

### Skip profile installation with fastlane sigh --skip_install

Source: https://docs.fastlane.tools/actions/get_provisioning_profile

Generates the provisioning profile but skips installing it on the local machine. By default, sigh installs the downloaded profile.

```bash
fastlane sigh --skip_install

```

--------------------------------

### Run match for development on new machine

Source: https://docs.fastlane.tools/actions/match

Command to set up certificates and provisioning profiles on a new machine.

```bash
fastlane match development
```

--------------------------------

### setup_ci

Source: https://docs.fastlane.tools/actions/setup_ci

Sets up the keychain and match to work with CI. Creates a temporary keychain, switches match to readonly mode, and configures log/test result paths.

```APIDOC
## setup_ci

### Description
Setup the keychain and match to work with CI. Creates a new temporary keychain for use with match, switches match to readonly mode, and sets up log and test result paths to be easily collectible.

### Method
N/A (Fastlane Action)

### Endpoint
N/A (Fastlane Action)

### Parameters
#### Action Parameters
- **force** (boolean) - Optional - Force setup, even if not executed by CI. Default: `false`
- **provider** (string) - Optional - CI provider. If none is set, the provider is detected automatically.
- **timeout** (integer) - Optional - Set a custom timeout in seconds for keychain. Set `0` if you want to specify 'no time-out'. Default: `3600`
- **keychain_name** (string) - Optional - Set a custom keychain name. Default: `fastlane_tmp_keychain`
- **set_default_keychain** (boolean) - Optional - Set the temporary keychain as the system default. Default: `true`

### Request Example
```ruby
setup_ci(
  provider: "circleci"
)
```

```ruby
setup_ci(
  provider: "circleci",
  timeout: 0
)
```

```ruby
setup_ci(
  provider: "circleci",
  timeout: 0,
  keychain_name: "custom_keychain_name"
)
```

### Response
#### Success Response (200)
No explicit response body. The action completes successfully if no errors are raised.

#### Response Example
N/A

### CLI Usage
To run this action from the command line, use:
```
fastlane run setup_ci
```

To pass parameters, use the `:` symbol:
```
fastlane run setup_ci parameter1:"value1" parameter2:"value2"
```

### Notes
- Supported platforms: ios, mac
- Author: @mollyIV, @svenmuennich
- This action helps with CI integration. Add to the top of your Fastfile if you use CI.

```

--------------------------------

### set_pod_key example

Source: https://docs.fastlane.tools/actions/set_pod_key

Example of using set_pod_key in a Fastfile to set a key-value pair for a project.

```ruby
set_pod_key(
  key: "APIToken",
  value: "1234",
  project: "MyProject"
)
```

--------------------------------

### Basic setup_jenkins usage

Source: https://docs.fastlane.tools/actions/setup_jenkins

Add this action to your Fastfile to set up Jenkins integration. It will configure keychains, code signing, output directories, and result bundles.

```ruby
setup_jenkins

```

--------------------------------

### Example invocation_urls.txt file

Source: https://docs.fastlane.tools/actions/appstore

Example content for the invocation_urls.txt file, which contains comma-separated URLs.

```text
http://localhost.com/1, http://localhost.com/2
```

--------------------------------

### Install provisioning profile from path

Source: https://docs.fastlane.tools/actions/install_provisioning_profile

Installs the provisioning profile at the given path for the current user. The `path` parameter is required and should point to a `.mobileprovision` file.

```ruby
install_provisioning_profile(path: "profiles/profile.mobileprovision")

```

--------------------------------

### Install Firebase App Distribution plugin

Source: https://docs.fastlane.tools/getting-started/android/beta-deployment

Installs the Firebase App Distribution plugin for fastlane.

```shell
fastlane add_plugin firebase_app_distribution
```

--------------------------------

### List installed profiles with fastlane sigh manage

Source: https://docs.fastlane.tools/actions/get_provisioning_profile

Lists all provisioning profiles installed locally.

```bash
fastlane sigh manage

```

--------------------------------

### setup_travis

Source: https://docs.fastlane.tools/actions/setup_travis

Sets up the keychain and match to work with Travis CI. Creates a temporary keychain and switches match to readonly mode.

```APIDOC
## setup_travis

### Description
Setup the keychain and match to work with Travis CI. Creates a new temporary keychain for use with match and switches match to readonly mode to not create new profiles/certs on CI.

### Method
N/A (fastlane action)

### Endpoint
N/A (fastlane action)

### Parameters
#### Action Parameters
- **force** (boolean) - Optional - Force setup, even if not executed by travis. Default: `false`

### Request Example
```ruby
setup_travis
```

### Response
#### Success Response
No explicit response. The action completes successfully if no errors are raised.

#### Response Example
N/A

```

--------------------------------

### cocoapods

Source: https://docs.fastlane.tools/actions/cocoapods

Runs `pod install` for the project. Supports optional parameters to customize the installation behavior.

```APIDOC
## [RUN] cocoapods

### Description
Runs `pod install` for the project. If you use CocoaPods you can use the `cocoapods` integration to run `pod install` before building your app.

### Method
RUN

### Endpoint
cocoapods

### Parameters
#### Optional Parameters
- **repo_update** (boolean) - Default: `false` - Add `--repo-update` flag to `pod install` command
- **clean_install** (boolean) - Default: `false` - Execute a full pod installation ignoring the content of the project cache
- **silent** (boolean) - Default: `false` - Execute command without logging output
- **verbose** (boolean) - Default: `false` - Show more debugging information
- **ansi** (boolean) - Default: `true` - Show output with ANSI codes
- **use_bundle_exec** (boolean) - Default: `true` - Use bundle exec when there is a Gemfile presented
- **podfile** (string) - Optional - Explicitly specify the path to the Cocoapods' Podfile. You can either set it to the Podfile's path or to the folder containing the Podfile file
- **error_callback** (block) - Optional - A callback invoked with the command output if there is a non-zero exit status
- **try_repo_update_on_error** (boolean) - Default: `false` - Retry with --repo-update if action was finished with error
- **deployment** (boolean) - Default: `false` - Disallow any changes to the Podfile or the Podfile.lock during installation
- **allow_root** (boolean) - Default: `false` - Allows CocoaPods to run as root
- **clean** (boolean) - Default: `true` - **DEPRECATED!** (Option renamed as clean_install) Remove SCM directories
- **integrate** (boolean) - Default: `true` - **DEPRECATED!** (Option removed from cocoapods) Integrate the Pods libraries into the Xcode project(s)

### Request Example
```ruby
cocoapods
```

```ruby
cocoapods(
  clean_install: true,
  podfile: "./CustomPodfile"
)
```

### Response
#### Success Response
- Returns the result of the `pod install` command execution.

#### Response Example
(No explicit response example provided in the source.)

### CLI Usage
To run this action from the command line, use:
```
fastlane run cocoapods
```

To pass parameters, use the `:` symbol, for example:
```
fastlane run cocoapods parameter1:"value1" parameter2:"value2"
```

Note: The CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. `param:"1,2,3"`). Hashes are not currently supported.
```

--------------------------------

### bundle_install

Source: https://docs.fastlane.tools/actions

This action runs `bundle install` (if available). Supported on iOS, Android, and Mac.

```APIDOC
## bundle_install

### Description
This action runs `bundle install` (if available).

### Supported Platforms
- ios
- android
- mac

```

--------------------------------

### podio_item example

Source: https://docs.fastlane.tools/actions/podio_item

Example of using the podio_item action with an identifying value and a dictionary of field values.

```ruby
podio_item(
  identifying_value: "Your unique value",
  other_fields: {
    "field1" => "fieldValue",
    "field2" => "fieldValue2"
  }
)

```

--------------------------------

### Show get_provisioning_profile documentation

Source: https://docs.fastlane.tools/actions/get_provisioning_profile

Run this command in your terminal to display the documentation for the get_provisioning_profile action.

```bash
fastlane action get_provisioning_profile
```

--------------------------------

### Install dependencies and run fastlane lane

Source: https://docs.fastlane.tools/best-practices/continuous-integration/codemagic

Runs bundle install and then executes the fastlane lane 'beta' using bundle exec.

```yaml
scripts:
  - bundle install
  - bundle exec fastlane beta

```
Tokens:
Raw