Install Guide

Get Compose HotSwan running in your Android project in just a few minutes.

Install the IDE Plugin

Open your JetBrains IDE (Android Studio or IntelliJ IDEA), go to Settings → Plugins → Marketplace, and search for "Compose HotSwan". Click Install and restart the IDE. You can also install it directly from the JetBrains Marketplace.

Configure Gradle

Add the HotSwan compiler plugin to your project. Three files need to be updated:

Define the HotSwan compiler plugin in your version catalog so it can be referenced across modules.

libs.versions.toml

1[plugins]
2hotswan-compiler = { id = "com.github.skydoves.compose.hotswan.compiler", version = "1.0.8" }

Root build.gradle.kts

1alias(libs.plugins.hotswan.compiler) apply false

Apply the plugin in your app module. This enables the compiler transformations and automatically adds the HotSwan client library.

App module build.gradle.kts

1alias(libs.plugins.hotswan.compiler)

IDE and Gradle versions must match

The Gradle plugin version must match the IDE plugin version. When you update the IDE plugin, update the version in libs.versions.toml as well. The Gradle plugin automatically handles the client library dependency, minSdk 28 for debug builds, and required Kotlin compiler flags.

Build and Run Your App

Build and run your app normally with the Run button. The Gradle plugin auto-configures everything needed for hot reload in debug builds — no additional setup required.

Start HotSwan

Open the HotSwan panel via View → Tool Windows → HotSwan. Select your target device and click Start. The status will change to READY.

Once your app is running on the device, HotSwan connects automatically and the status changes to WATCHING.

Start Hot Reloading!

Edit any Kotlin file and save (Cmd+S / Ctrl+S). HotSwan detects the change, compiles only the modified code, and applies the update to your running app. Your UI updates instantly without losing any state.

Not just composables. You can also modify ViewModel methods, utility functions, resource values, and more. See the full list of supported changes.

Troubleshooting

Having issues? Check these common solutions.

Module Not Found

":app" module not found. Set the correct module path in Settings > Compose HotSwan (e.g. :app:androidApp for KMP projects).

HotSwan could not find the Gradle module you specified. Go to Settings → Tools → Compose HotSwan and set the correct module path. For standard projects, the default :app works. For Kotlin Multiplatform projects, use the full path like :app:androidApp.

App Launch Failed

Failed to launch activity. Check that App Package Name in Settings > Compose HotSwan matches the applicationId in build.gradle.kts.

The package name configured in HotSwan does not match your app's actual applicationId. Open Settings → Tools → Compose HotSwan and verify the App Package Name matches the applicationId in your module's build.gradle.kts.

Tool Window Not Visible

Go to View → Tool Windows → HotSwan. If it's not listed, check that the plugin is installed and enabled in Settings → Plugins.

Version Mismatch

HotSwan version mismatch: IDE plugin=1.0.3, Gradle plugin=1.0.0. Mismatched versions may cause build failures or unexpected behavior. Please update to the same version.

The IDE plugin and Gradle plugin versions must match. Check your IDE plugin version in Settings → Plugins and ensure the same version is set in your libs.versions.toml.

Crash After Reload

This usually means a structural change was detected, such as adding a new function or changing a data class. HotSwan detects this automatically and falls back to a full rebuild. If it persists, run your app again with the Run button.