flipper/docs/getting-started.md

id, title, sidebar_label

id	title	sidebar_label
getting-started	Getting Started	Getting Started

Flipper helps you debug Android and iOS apps running in an emulator/simulator or connected physical development devices. Flipper consists of two parts:

• The desktop app for macOS
• The native mobile SDKs for Android and iOS

To use Flipper, you need to add the mobile SDK to your app.

Setup

Desktop app

The desktop part of Flipper doesn't need any particular setup. Simply download the latest build of our app and launch it. The desktop app is available for macOS and requires a working installation of the Android/iOS development tools on your system.

Once you start Flipper and launch an emulator/simulator or connect a device, you will already be able to see the device logs in Flipper. To see app specific data, you need to integrate our native SDKs with your app.

Setup your Android app

Add the following permissions to your AndroidManifest.xml. The SDK needs these to communicate with the desktop app on localhost via adb. It won't make any external internet requests.

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

It's recommended that you add the following activity to the manifest too, which can help diagnose integration issues and other problems:

<activity android:name="com.facebook.flipper.android.diagnostics.FlipperDiagnosticActivity"
        android:exported="true"/>

Flipper is distributed via JCenter. Add the dependencies to your build.gradle file. You should also explicitly depend on soloader instead of relying on transitive dependency resolution which is getting deprecated with Gradle 5.

repositories {
  jcenter()
}

dependencies {
  debugImplementation 'com.facebook.flipper:flipper:0.14.2'
  debugImplementation 'com.facebook.soloader:soloader:0.5.1'
}

Now you can initialize Flipper in your Application's onCreate-method like this:

public class MyApplication extends Application {

  @Override
  public void onCreate() {
    super.onCreate();
    SoLoader.init(this, false);

    if (BuildConfig.DEBUG && FlipperUtils.shouldEnableFlipper(this)) {
      final FlipperClient client = AndroidFlipperClient.getInstance(this);
      client.addPlugin(new InspectorFlipperPlugin(this, DescriptorMapping.withDefaults()));
      client.start();
    }
  }
}

Android Snapshots

Feeling adventurous? We publish Android snapshot releases directly off of master.

You can get the latest version by adding the Maven Snapshot repository to your sources and pointing to the most recent -SNAPSHOT version.

repositories {
  maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
}

dependencies {
  debugImplementation 'com.facebook.flipper:flipper:0.14.3-SNAPSHOT'
  debugImplementation 'com.facebook.soloader:soloader:0.5.1'
}

Setup your iOS app

To integrate with an iOS app, you can use CocoaPods. Add the mobile Flipper SDK and its dependencies to your Podfile

Objective-c

Podfile for Objective-C projects will look like the following

project 'MyApp.xcodeproj'
source 'https://github.com/facebook/flipper.git'
source 'https://github.com/CocoaPods/Specs'
swift_version = "4.1"
flipperkit_version = '0.14.2'

target 'MyApp' do
  platform :ios, '9.0'

  pod 'FlipperKit', '~>' + flipperkit_version
  pod 'FlipperKit/FlipperKitLayoutComponentKitSupport', '~>' + flipperkit_version
  pod 'FlipperKit/SKIOSNetworkPlugin', '~>' + flipperkit_version
  pod 'FlipperKit/FlipperKitUserDefaultsPlugin', '~>' + flipperkit_version
  # This post_install script adds swift version to yogakit's pod target.
  # It also adds -DFB_SONARKIT_ENABLED=1 flag to OTHER_CFLAGS, necessary to build expose Flipper classes in the header files
  post_install do |installer|
	    installer.pods_project.targets.each do |target|
	        if ['YogaKit'].include? target.name
	            target.build_configurations.each do |config|
	                config.build_settings['SWIFT_VERSION'] = swift_version
	            end
	        end
	    end
	    file_name = Dir.glob("*.xcodeproj")[0]
	    app_project = Xcodeproj::Project.open(file_name)
	    app_project.native_targets.each do |target|
	        target.build_configurations.each do |config|
	          if (config.build_settings['OTHER_CFLAGS'])
	            if !(config.build_settings['OTHER_CFLAGS'].include? '-DFB_SONARKIT_ENABLED=1')
	              puts 'Adding -DFB_SONARKIT_ENABLED=1 in OTHER_CFLAGS...'
	              config.build_settings['OTHER_CFLAGS'] << '-DFB_SONARKIT_ENABLED=1'
	            end
	          else
	            puts 'OTHER_CFLAGS does not exist, assigining it to `$(inherited), -DFB_SONARKIT_ENABLED=1` '
	            config.build_settings['OTHER_CFLAGS'] = '$(inherited) -DFB_SONARKIT_ENABLED=1 '
	          end
	          app_project.save
	        end
	    end
   end
end

Install the dependencies by running pod install.When you open the Xcode workspace file for your app, you now can import and initialize Flipper in your AppDelegate. Before running your app, make sure that the flag -DFB_SONARKIT_ENABLED=1 is present in the OTHER_CFLAGS in your application's build settings.

#import <FlipperKit/FlipperClient.h>
#import <FlipperKitLayoutPlugin/FlipperKitLayoutPlugin.h>
#import <FlipperKitLayoutComponentKitSupport/FlipperKitLayoutComponentKitSupport.h>
#import <FlipperKitUserDefaultsPlugin/FKUserDefaultsPlugin.h>
#import <FlipperKitNetworkPlugin/FlipperKitNetworkPlugin.h>
#import <SKIOSNetworkPlugin/SKIOSNetworkAdapter.h>

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  FlipperClient *client = [FlipperClient sharedClient];
  SKDescriptorMapper *layoutDescriptorMapper = [[SKDescriptorMapper alloc] initWithDefaults];
  [FlipperKitLayoutComponentKitSupport setUpWithDescriptorMapper: layoutDescriptorMapper];
  [client addPlugin: [[FlipperKitLayoutPlugin alloc] initWithRootNode: application
                                                 withDescriptorMapper: layoutDescriptorMapper]];

  [client addPlugin:[[FKUserDefaultsPlugin alloc] initWithSuiteName:nil]];  [client start];
  [client addPlugin: [[FlipperKitNetworkPlugin alloc] initWithNetworkAdapter:[SKIOSNetworkAdapter new]]];
  [client start];
  ...
}
@end

Swift

Podfile for the swift projects will look like the following:

project 'MyApp.xcodeproj'
source 'https://github.com/facebook/flipper.git'
source 'https://github.com/CocoaPods/Specs'
swift_version = "4.1"
flipperkit_version = '0.14.2'

target 'MyApp' do
  platform :ios, '9.0'

  pod 'FlipperKit', '~>' + flipperkit_version
  # Layout and network plugins are not yet supported for swift projects
  pod 'FlipperKit/FlipperKitLayoutComponentKitSupport', '~>' + flipperkit_version
  pod 'FlipperKit/SKIOSNetworkPlugin', '~>' + flipperkit_version
  pod 'FlipperKit/FlipperKitUserDefaultsPlugin', '~>' + flipperkit_version

  # If you use `use_frameworks!` in your Podfile, 
  # uncomment the below $static_framework array and also 
  # the pre_install section.  This will cause Flipper and 
  # it's dependencies to be static and all other pods to 
  # be dynamic.

  # $static_framework = ['FlipperKit', 'Flipper', 'Folly',
  #   'CocoaAsyncSocket', 'ComponentKit', 'DoubleConversion', 
  #   'glog', 'PeerTalk', 'RSocket', 'Yoga', 'YogaKit', 
  #   'CocoaLibEvent', 'OpenSSL-Static', 'boost-for-react-native']
  
  # pre_install do |installer|
  #     installer.pod_targets.each do |pod|
  #       if $static_framework.include?(pod.name)  
  #         pod.host_requires_frameworks = false
  #       end
  #   end
  # end

# This post_install script adds -DFB_SONARKIT_ENABLED flag to OTHER_SWIFT_FLAGS, necessary to build swift target
    post_install do |installer|
      file_name = Dir.glob("*.xcodeproj")[0]
      app_project = Xcodeproj::Project.open(file_name)
      app_project.native_targets.each do |target|
          target.build_configurations.each do |config|
            if (config.build_settings['OTHER_SWIFT_FLAGS'])
              if !(config.build_settings['OTHER_SWIFT_FLAGS'].include? '-DFB_SONARKIT_ENABLED')
                puts 'Adding -DFB_SONARKIT_ENABLED ...'
                swift_flags = config.build_settings['OTHER_SWIFT_FLAGS']
                if swift_flags.split.last != '-Xcc'
                  config.build_settings['OTHER_SWIFT_FLAGS'] << ' -Xcc'
                end
                config.build_settings['OTHER_SWIFT_FLAGS'] << ' -DFB_SONARKIT_ENABLED'
              end
            else
              puts 'OTHER_SWIFT_FLAGS does not exist thus assigning it to `$(inherited) -Xcc -DFB_SONARKIT_ENABLED`'
              config.build_settings['OTHER_SWIFT_FLAGS'] = '$(inherited) -Xcc -DFB_SONARKIT_ENABLED'
            end
            app_project.save
          end
        end
    end
  end

Install the dependencies by running pod install.When you open the Xcode workspace file for your app, you now can import and initialize Flipper in your AppDelegate by following the below mentioned example. Before running your app, make sure that the flag -Xcc -DFB_SONARKIT_ENABLED is present in the OTHER_SWIFT_FLAGS in your application's build settings.

import UIKit
import FlipperKit
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

  var window: UIWindow?


  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Override point for customization after application launch.
    let client = FlipperClient.shared()
    let layoutDescriptorMapper = SKDescriptorMapper(defaults: ())
    FlipperKitLayoutComponentKitSupport.setUpWith(layoutDescriptorMapper)
    client?.add(FlipperKitLayoutPlugin(rootNode: application, with: layoutDescriptorMapper!))
    client?.start()
    return true
  }
}

• We haven't released the dependency to CocoaPods yet, here is the issue by which you can track.
• If you do not use CocoaPods as a dependency management tool then currently there is no way to integrate FlipperKit other than manually including all the dependencies and building it.
• For Android, Flipper works with both emulators and physical devices connected through USB. However on iOS, we don't yet support physical devices.

Ready for takeoff

Finally, you need to add plugins to your Flipper client. Above we have only added the Layout Inspector plugin to get you started. See Network Plugin and Layout Inspector Plugin for information on how to add them, and also enable Litho or ComponentKit support. You can check the sample apps in the GitHub repo for examples of integrating other plugins.

Having trouble?

See the troubleshooting page for help with known problems.