Android Pluto

Pluto is an on-device debugging framework for Android applications, which helps in the inspection of HTTP requests/responses, captures Crashes, and ANRs, and manipulates application data on the go.

It comes with a UI to monitor and share the information, as well as APIs to access and use that information in your application.

🖇 Integrate Pluto in your application

Add Gradle Dependencies

Pluto is distributed through mavenCentral. To use it, you need to add the following Gradle dependency to your build.gradle file of your app module.

Note: add both the pluto and the pluto-no-op variant to isolate Pluto from release builds.

def plutoVersion = "2.1.9"

dependencies {
  ....
  debugImplementation "com.plutolib:pluto:$plutoVersion"
  releaseImplementation "com.plutolib:pluto-no-op:$plutoVersion"
  ....
}

Initialize Pluto

Now to start using Pluto, initialize Pluto SDK from you application class by passing context to it.

Pluto.Installer(this)
  .addPlugin(....)
  .install()

Install plugins

Unlike version 1.x.x, Pluto now allows developers to add debuggers as plugin bundle or individual plugins based on their need.

Plugin bundle comes with all the basic plugins bundled together as single dependency.

dependencies {
  ....
  debugImplementation "com.plutolib.plugins:bundle-core:$plutoVersion"
  releaseImplementation "com.plutolib.plugins:bundle-core-no-op:$plutoVersion"
  ....
}

But, if you want to use individual plugins, here is the list of some plugins provided by us

We will be adding more to the list. So please stay tuned.
Please refer to their respective README for integration steps.

You can also help us expand the Pluto ecosystem now.
Pluto now allows to develop custom debuggers as plugin. Read Develop Custom Plugins.

🎉 You are all set!

Now re-build and run your app, you will receive a notification from Pluto, use it to access Pluto UI.

Grouping Plugins (Optional)

Pluto now allows to group similar plugins together to have better readability & categorization.
To create a group, we need to override PluginGroup & attach Plugins to it. (We have taken the example of grouping datasource plugins together)

class DataSourcePluginGroup : PluginGroup("datasource-group") {

    override fun getConfig() = PluginGroupConfiguration(
        name = "DataSource Group"
    )

    override fun getPlugins() = listOf(
        PlutoSharePreferencesPlugin(),
        PlutoDatastorePreferencesPlugin(),
        PlutoRoomsDatabasePlugin()
    )
}

Then add the group to Plugin installer.

Pluto.Installer(this)
  .addPluginGroup(DataSourcePluginGroup())
  .install()

📝 Contribution

We're looking for contributors, help us improve Pluto. 😁

Please refer to your Contribution guidelines to get started.

Have an idea to improve Pluto? Let's connect on

📃 License

Copyright 2021 Plutolib.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

NikCapko/pluto