Guides

IntelliJ / Android Studio Plugin

The Kolt Project Wizard plugin adds a Kolt entry to the New Project wizard in Android Studio and IntelliJ IDEA, scaffolding a fully wired Kolt project in seconds.

What it creates

When you select File → New Project → Kolt, fill in three fields (Project Name, Package name, Project type), and click Create, the wizard generates a ready-to-build project structure:

<ProjectName>/
  settings.gradle.kts      ← koltlibs + kmplibs catalogs wired, modules included
  build.gradle.kts          ← plugins declared apply false
  gradle.properties         ← AndroidX flags, POM metadata, kotlin.code.style
  gradlew + gradle/wrapper/ ← immediately buildable, no setup required
  app/
    build.gradle.kts        ← convention plugin applied, namespace set
    src/main/kotlin/<pkg>/
    src/main/res/           ← (Android only)
  shared/                   ← (KMP only)
    build.gradle.kts        ← kmp.library-koin-compose applied
    src/commonMain/kotlin/<pkg>/
    src/androidMain/kotlin/<pkg>/
    src/iosMain/kotlin/<pkg>/
  CLAUDE.md                 ← AI-agent steering stub (fill in project facts)
  AGENTS.md                 ← AI-agent steering stub (fill in project facts)
  docs/
    CODING_STANDARDS.md     ← binding coding rules (plugin-owned, auto-updates)
    ARCHITECTURE.md         ← layering, DI, offline-first patterns
    TESTING.md              ← test patterns, fakes, coverage targets
    KOLT.md                 ← plugin & library API reference

The first ./gradlew :app:assembleDebug run auto-scaffolds the Compose theme XML resources into src/main/res/.

Build the plugin locally

The IntelliJ plugin lives in intellij-plugin/, which is a standalone Gradle build — not part of the main UtilsLibs composite build.

# Enter the plugin directory
cd intellij-plugin

# Run a sandboxed IDE instance with the plugin installed (for manual testing)
./gradlew runIde

# Build the distributable ZIP
./gradlew buildPlugin
# Output: build/distributions/kolt-intellij-plugin-1.0.0.zip

Install from disk

To install the locally built plugin into your Android Studio or IntelliJ IDEA installation:

  1. Run ./gradlew buildPlugin inside intellij-plugin/.
  2. Open Android Studio or IntelliJ IDEA.
  3. Go to Settings → Plugins → ⚙ → Install Plugin from Disk…
  4. Select build/distributions/kolt-intellij-plugin-1.0.0.zip.
  5. Restart the IDE.
  6. Go to File → New Project and look for Kolt in the left panel.

Using the wizard

After installing, the wizard presents three fields:

Field Example Notes
Project Name MyApp Used as the root directory name and Gradle project name
Package Name com.example.myapp Applied to namespace and source directories
Project Type Android or KMP Selects the android-project or kmp-project template

Click Create. The IDE opens the generated project, which is immediately buildable.

How templates stay current

The wizard bundles its project templates from project-templates/ at plugin build time. This is the same source used by the scripts/new-project.sh CLI script — there is no duplication. Editing the templates in that directory and rebuilding the plugin ensures both tools stay in sync.

The docs/ files inside every generated project (CODING_STANDARDS.md, KOLT.md, etc.) are plugin-owned — they are automatically overwritten whenever the consumer project updates its Kolt plugin version, so AI agents in downstream projects always read current rules.

Target IDE versions

The plugin is configured to target Android Studio Meerkat (2024.3.1) and later.

To target IntelliJ IDEA Community instead, change one line in intellij-plugin/build.gradle.kts:

// Change:
androidStudio("2024.3.1.14")
// To:
ideaCommunity("2024.3.1")

Publish to JetBrains Marketplace

To distribute the plugin publicly via the JetBrains Marketplace:

  1. Obtain a JetBrains Marketplace token.
  2. Set the environment variable: export PUBLISH_TOKEN=<your-token>
  3. Sign the plugin (requires a certificate — see JetBrains Marketplace signing documentation).
  4. Run: ./gradlew publishPlugin

Related