A desktop debugging platform for mobile developers.
Flipper (formerly Sonar) is a platform for debugging mobile apps on iOS and Android. Visualize, inspect, and control your apps from a simple desktop interface. Use Flipper as is or extend it using the plugin API.
Flipper aims to be your number one companion for mobile app development on iOS and Android. Therefore, we provide a bunch of useful tools, including a log viewer, interactive layout inspector, and network inspector.
Flipper is built as a platform. In addition to using the tools already included, you can create your own plugins to visualize and debug data from your mobile apps. Flipper takes care of sending data back and forth, calling functions, and listening for events on the mobile app.
Both Flipper's desktop app and native mobile SDKs are open-source and MIT licensed. This enables you to see and understand how we are building plugins, and of course, join the community and help to improve Flipper. We are excited to see what you will build on this platform.
This repository includes all parts of Flipper. This includes:
Please refer to our Getting Started guide to set up Flipper.
git clone https://github.com/facebook/flipper.git cd flipper/desktop yarn yarn start
NOTE: If you're on Windows, you need to use Yarn 1.5.1 until this issue is resolved.
--linuxor any combination of them to
yarn buildto build a release zip file for the given platform(s). E.g.
yarn build --mac --version $buildNumber
You can find the resulting artifact in the
cd iOS/Sample rm -f Podfile.lock pod install --repo-update open Sample.xcworkspace
You can omit
--repo-updateto speed up the installation, but watch out as you may be building against outdated dependencies.
Start up an android emulator and run the following in the project root:
bash ./gradlew :sample:installDebug
cd react-native/ReactNativeFlipperExample yarn yarn android
Note that the first 2 steps need to be done only once.
Alternatively, the app can be started on
Older yarn versions might show an error / hang with the message 'Waiting for the other yarn instance to finish'. If that happens, run the command
yarnfirst separately in the directory
Find the full documentation for this project at fbflipper.com.
Our documentation is built with Docusaurus. You can build it locally by running this:
cd website yarn yarn start
See the CONTRIBUTING file for how to help out.
Flipper is MIT licensed, as found in the LICENSE file.