Skip to main content

tools-apple

Build npm version

@rnx-kit/tools-apple is a collection of functions for deploying apps on iOS or macOS.

Usage:

import * as tools from "@rnx-kit/tools-apple";
CategoryFunctionDescription
cocoapodscheckPodsManifestLock(xcworkspace)Returns whether the CocoaPods sandbox is in sync with its Podfile.lock.
iosbootSimulator(simulator)Boots the simulator with the specified UDID.
iosgetAvailableSimulators(search)Returns a list of available iOS simulators.
iosgetDevices()Returns a list of available iOS simulators and physical devices.
iosinstall(device, app)Installs the specified app bundle on specified simulator or physical device.
ioslaunch(device, app)Launches the specified app bundle on specified simulator or physical device.
iosselectDevice(deviceNameOrPlatformIdentifier, deviceType, logger)Returns the simulator or physical device with the specified name.
xcodegetBuildSettings(xcworkspace, params)Returns build settings for specified Xcode workspace and the parameters used to build it.
xcodegetDeveloperDirectory()Returns the path to the active developer directory.
xcodegetDevicePlatformIdentifier(buildParams)Returns device platform identifier for specified platform and destination.
xcodeparsePlist(app)Parses and returns the information property list of specified bundle.
xcodexcodebuild(xcworkspace, params, log)Builds the specified .xcworkspace.