{"id":51145685,"url":"https://github.com/sproctor/potassium","last_synced_at":"2026-06-26T02:30:50.350Z","repository":{"id":367376921,"uuid":"1280505842","full_name":"sproctor/potassium","owner":"sproctor","description":"Package, distribute, and auto-update Compose/JVM desktop apps (Gradle plugin + updater library)","archived":false,"fork":false,"pushed_at":"2026-06-25T17:40:17.000Z","size":2338,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-25T19:14:41.356Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sproctor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"docs/roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":"kdroidFilter","ko_fi":"lomityaesh"}},"created_at":"2026-06-25T16:47:12.000Z","updated_at":"2026-06-25T17:40:17.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sproctor/potassium","commit_stats":null,"previous_names":["sproctor/potassium"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sproctor/potassium","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproctor%2Fpotassium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproctor%2Fpotassium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproctor%2Fpotassium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproctor%2Fpotassium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sproctor","download_url":"https://codeload.github.com/sproctor/potassium/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sproctor%2Fpotassium/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34801014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-26T02:00:06.560Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-26T02:30:49.659Z","updated_at":"2026-06-26T02:30:50.341Z","avatar_url":"https://github.com/sproctor.png","language":"Kotlin","funding_links":["https://github.com/sponsors/kdroidFilter","https://ko-fi.com/lomityaesh"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"art/header.png\" alt=\"Potassium\" /\u003e\n\u003c/p\u003e\n\n# Potassium\n\n[![Packager](https://img.shields.io/maven-central/v/com.seanproctor/potassium-packager?label=potassium-packager)](https://central.sonatype.com/artifact/com.seanproctor/potassium-packager)\n[![Updater](https://img.shields.io/maven-central/v/com.seanproctor/potassium-updater?label=potassium-updater)](https://central.sonatype.com/artifact/com.seanproctor/potassium-updater)\n[![License: MIT](https://img.shields.io/github/license/sproctor/potassium)](https://github.com/sproctor/potassium/blob/main/LICENSE)\n![Kotlin](https://img.shields.io/badge/Kotlin-2.0%2B-7F52FF?logo=kotlin\u0026logoColor=white)\n![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Windows%20%7C%20Linux-blue)\n\n**Potassium packages, distributes, and auto-updates Compose / JVM desktop applications** on macOS, Windows, and Linux. It ships two artifacts from one repo:\n\n- **`potassium-packager`** ([`plugin/`](plugin/)) — a Gradle plugin that builds installers, signs/notarizes, and generates auto-update metadata. It is a drop-in extension of the official JetBrains Compose Desktop plugin: keep your existing `compose.desktop` configuration and add the capabilities you need.\n- **`potassium-updater`** ([`updater/`](updater/)) — a standalone runtime library that self-updates an installed app from the manifests the plugin produces.\n\n## What it does\n\n- **Many installer formats** — Linux `deb` / `rpm` / `AppImage` / `snap` / `flatpak`, Windows `msi` / `exe` (NSIS) / `appx`, macOS `dmg` / `pkg`, plus archives (`zip`, `tar`, `7z`)\n- **Store-ready builds** — Mac App Store, Microsoft Store, Snapcraft, Flathub\n- **Code signing \u0026 notarization** — Windows (PFX / Azure) and macOS, built into the build pipeline\n- **Auto-update** — electron-builder-based update metadata (`latest-*.yml`) generated alongside your installers, with SHA-512 verification\n- **GraalVM Native Image** — standalone native binaries with automatic reachability-metadata resolution (no manual reflection config for most apps)\n- **Deep links \u0026 file associations** — protocol handlers and file type registration on all platforms\n- **AOT cache, ProGuard, trusted CA certificates**, and more — all opt-in via the DSL\n\n## Quick Start\n\n```kotlin\n// settings.gradle.kts\npluginManagement {\n    repositories {\n        gradlePluginPortal()\n        mavenCentral()\n    }\n}\n```\n\n```kotlin\n// build.gradle.kts\nplugins {\n    kotlin(\"jvm\") version \"...\"\n    id(\"org.jetbrains.kotlin.plugin.compose\") version \"...\"\n    id(\"org.jetbrains.compose\") version \"...\"\n    id(\"com.seanproctor.potassium\") version \"0.1.0\"\n}\n\npotassium {\n    mainClass = \"com.example.MainKt\"\n    packageName = \"MyApp\"\n    packageVersion = \"1.0.0\"\n\n    macOS { targetFormats(MacOSTargetFormat.Dmg) }\n    windows { targetFormats(WindowsTargetFormat.Nsis) }\n    linux { targetFormats(LinuxTargetFormat.Deb) }\n}\n```\n\n```bash\n./gradlew run                              # Run locally\n./gradlew packageDistributionForCurrentOS  # Build installers for the current OS\n```\n\n\u003e Kotlin DSL types live under `com.seanproctor.potassium.*` (for example\n\u003e `import com.seanproctor.potassium.dsl.MacOSTargetFormat`).\n\n## Documentation\n\nFull documentation — configuration reference, per-platform targets, code signing, auto-update, GraalVM, and CI/CD — is in the [`docs/`](docs/) directory and published at the project site.\n\nA good starting point is [Getting Started](docs/getting-started.md), followed by [Configuration](docs/configuration.md) and [Migration from org.jetbrains.compose](docs/migration.md).\n\n## Sample\n\n[`sample/`](sample/) is a runnable Compose Multiplatform desktop app packaged by this plugin. It's a\ncomposite build that uses the plugin from source, so `cd sample \u0026\u0026 ./gradlew run` (or\n`packageDistributionForCurrentOS`) works against your local checkout. See [`sample/README.md`](sample/README.md).\n\n## Updater\n\n[`updater/`](updater/) is the `potassium-updater` runtime library — a small, dependency-light\ncompanion that self-updates an installed desktop app from the electron-builder-style\n`latest-*.yml` manifests the plugin generates. It detects how the app was installed at runtime,\npicks the matching artifact, verifies its SHA-512, and runs the platform-appropriate installer.\nAdd it to your app's runtime classpath:\n\n```kotlin\ndependencies {\n    implementation(\"com.seanproctor:potassium-updater:0.1.0\")\n}\n```\n\nSee [`updater/README.md`](updater/README.md) and the [Auto Update](docs/auto-update.md) guide.\n\n## Coordinates\n\n- **Plugin id:** `com.seanproctor.potassium` (artifact `com.seanproctor:potassium-packager`)\n- **Updater library:** `com.seanproctor:potassium-updater`\n- **Latest version:** `0.1.0`\n- **Published to:** Maven Central\n- **Repository:** https://github.com/sproctor/potassium\n\n## Requirements\n\n| Requirement | Version | Note |\n|-------------|---------|------|\n| JDK | 17+ (25+ for AOT cache) | |\n| Gradle | 8.0+ | |\n| Kotlin | 2.0+ | |\n| Node.js | 18+ | Required by electron-builder for installer formats |\n\n## License\n\nMIT — See [LICENSE](LICENSE).\n\u003c/content\u003e\n\u003c/invoke\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsproctor%2Fpotassium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsproctor%2Fpotassium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsproctor%2Fpotassium/lists"}