Repolode
mikepenz

mikepenz/AboutLibraries

A Gradle plugin and Compose UI library that collects a project's dependency licenses at build time and shows them in Android and multiplatform apps.

Stars
4,493
Forks
608
Open issues
6
Last commit
4 days ago

What is it?

AboutLibraries generates a metadata file listing every dependency and license of a Gradle project, including Kotlin Multiplatform targets. The collection runs at build time, so the app reads a pre-generated aboutlibraries.json rather than scanning dependencies at runtime.

On top of that metadata, the project provides Compose UI modules for Material 2 and Material 3 along with a core module for reading the data programmatically. Supported targets include Android, JVM desktop, iOS, native, JS and Wasm, and the UI can be customized through variants, density, detail modes and custom row slots.

The library also offers CSV and text exports, compliance reports, a strict mode that can fail builds on disallowed licenses, and an option to surface funding information for dependencies.

Key features

  • 01Collects dependency and license metadata at Gradle build time
  • 02Compose UI modules for Material 2 and Material 3
  • 03Works across Android, desktop, iOS, web and Wear targets
  • 04CSV and text exports plus compliance reports
  • 05Strict mode that can fail builds on disallowed licenses
  • 06Customizable header, footer and library row slots

Use cases

  • Adding an open source licenses screen to an Android app built with Compose
  • Sharing a licenses screen across a Kotlin Multiplatform app
  • Generating license reports for compliance review
  • Enforcing an allowed-license list in CI builds

Quick start

  1. 1

    Apply the Gradle plugin in your app build file

  2. 2

    Add the Compose UI module matching your Material version

  3. 3

    Load the generated data and show it with LibrariesContainer

Things to know

  • Fetching remote licenses or funding information requires a GitHub API token.
  • The Gradle plugin does not generate metadata automatically unless you use the Android variant or run the export tasks.

In collections

Topics

#android#compose#kotlin-multiplatform#gradle#licenses#compliance#open-source#aboutlibraries#android-development#android-library

FAQ

What is AboutLibraries?
A Gradle plugin and Compose UI library that collects a project's dependency licenses at build time and shows them in Android and multiplatform apps. AboutLibraries generates a metadata file listing every dependency and license of a Gradle project, including Kotlin Multiplatform targets. The collection runs at build time, so the app reads a pre-generated aboutlibraries.json rather than scanning dependencies at runtime.
Is AboutLibraries free to use? What license does it have?
AboutLibraries is open source under the Apache-2.0 license. Check the license terms before using it in commercial products.
Is AboutLibraries still maintained?
Actively maintained. The last commit to AboutLibraries was on Nov 2, 2026.
What can I use AboutLibraries for?
Adding an open source licenses screen to an Android app built with Compose Sharing a licenses screen across a Kotlin Multiplatform app Generating license reports for compliance review Enforcing an allowed-license list in CI builds
How do I install AboutLibraries?
Apply the Gradle plugin in your app build file Add the Compose UI module matching your Material version Load the generated data and show it with LibrariesContainer
Where can I get AboutLibraries?
The source code and installation instructions are on GitHub: https://github.com/mikepenz/AboutLibraries

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects