unlock_keychain

Unlock a keychain

Unlocks the given keychain file and adds it to the keychain search list Keychains can be replaced with add_to_search_list: :replace

unlock_keychain
Supported platforms ios, android, mac
Author @xfreebird

4 Examples

unlock_keychain( # Unlock an existing keychain and add it to the keychain search list
  path: "/path/to/KeychainName.keychain",
  password: "mysecret"
)
unlock_keychain( # By default the keychain is added to the existing. To replace them with the selected keychain you may use `:replace`
  path: "/path/to/KeychainName.keychain",
  password: "mysecret",
  add_to_search_list: :replace # To only add a keychain use `true` or `:add`.
)
unlock_keychain( # In addition, the keychain can be selected as a default keychain
  path: "/path/to/KeychainName.keychain",
  password: "mysecret",
  set_default: true
)
unlock_keychain( # If the keychain file is located in the standard location `~/Library/Keychains`, then it is sufficient to provide the keychain file name, or file name with its suffix.
  path: "KeychainName",
  password: "mysecret"
)

Parameters

Key Description
path Path to the keychain file
password Keychain password
add_to_search_list Add to keychain search list
set_default Set as default keychain


To show the documentation in your terminal, run

fastlane action unlock_keychain

View source code


Back to actions