Unlock a keychain
Unlocks the given keychain file and adds it to the keychain search list.
Keychains can be replaced with
|Supported platforms||ios, android, mac|
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" )
||Path to the keychain file||
||Add to keychain search list, valid values are true, false, :add, and :replace||
||Set as default keychain||
* = default value is dependent on the user's system
To show the documentation in your terminal, run
fastlane action unlock_keychain
It is recommended to add the above action into your
Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
fastlane run unlock_keychain
To pass parameters, make use of the
: symbol, for example
fastlane run unlock_keychain parameter1:"value1" parameter2:"value2"
It's important to note that 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.
It is recommended to add all fastlane actions you use to your
This action, just like the rest of fastlane, is fully open source, view the source code on GitHub