Kickoff

Deterministic Android Scaffolding Engine, Multi-Module Compose Templates, Day-2 Generators & AI MCP Platform

Kickoff is a deterministic developer CLI and AI engineering platform designed to bootstrap and evolve production-grade Android applications and redistributable SDK libraries. It implements Google's Now-in-Android Clean Architecture, Jetpack Compose (Material 3), Hilt, Room, Retrofit, Binary Compatibility Validator, and an integrated static code analysis suite.

Scaffolded projects don't just ship with code—they come equipped with an integrated AI Agent Swarm dynamically synthesized for GitHub Copilot, Claude Code, Cursor, and Antigravity / Generic AI agents, backed by a native Model Context Protocol (MCP) server.

Documentation Index

📖 Architecture Deep-Dive: Complete module topologies for both App (now-in-android) and SDK (android-sdk) archetypes.
🤖 AI Agent Kit & MCP: Catalog of 16 specialized agents, 25 atomic skills, cross-IDE setup, and stdio MCP server.
🛡️ Quality Verifier Plugin: Detekt (Compose rules), Spotless (Ktlint), typed Android Lint, Architecture boundary verifier, and Kover.
🤝 Contributing Guide & Code of Conduct: How to build, test, and contribute to Kickoff under Contributor Covenant 2.1.
🔒 Security Policy: Vulnerability reporting procedures and supported version matrix.
♿ Accessibility: CLI and Android Compose accessibility commitments.

Monorepo Architecture

Kickoff unifies five mature Android engineering foundations into a single modern monorepo:

Kickoff-V2/
├── kickoff                              # Root wrapper script for the CLI generator
├── kickoff-cli/                         # Standalone CLI & MCP server (Kotlin 2.0.21 + Clikt 5)
├── quality-verifier/                    # Standalone Gradle plugin (eu.andrer757.quality-verifier)
├── templates/
│   ├── now-in-android/                  # Multi-module App template (Now-in-Android)
│   │   ├── build-logic/                 # Gradle convention plugins
│   │   ├── gradle/libs.versions.toml    # Centralized version catalog
│   │   ├── app/                         # Application entrypoint & navigation
│   │   ├── core/                        # Core capabilities (:core:data, :core:testing, :core:model, etc.)
│   │   ├── feature/                     # Feature modules (:feature:home)
│   │   ├── .agents/                     # Single Source of Truth (SSoT) for AI swarm
│   │   └── scripts/                     # Cross-platform AI setup scripts (.sh, .ps1)
│   └── android-sdk/                     # Multi-module Android SDK + Sample template
│       ├── build-logic/                 # SdkLibrary, SdkCompose, SdkPublish convention plugins
│       ├── sdk-core/                    # Headless engine (explicitApi, zero-Hilt, consumer ProGuard)
│       ├── sdk-ui/                      # Compose UI components (@Immutable / @Stable)
│       ├── sdk-testing/                 # Consumer test fakes & rules (FakeSdkClient)
│       └── sample/                      # Showcase Compose application
├── .github/workflows/                   # Monorepo CI & automated release workflows
└── .agents/skills/kickoff-scaffold/     # AI Agent skill for invoking Kickoff

Quickstart

Prerequisites

JDK 21 (Eclipse Temurin 21 recommended; JDK 17 cannot build or run Kickoff)
Android SDK (API 35 SDK installed)

1. Install Kickoff CLI

Option A: One-Command Binary Installer (Linux & macOS)

curl -fsSL https://raw.githubusercontent.com/Andrer757/Kickoff-V2/main/install.sh | bash

Option B: Homebrew

brew tap Andrer757/kickoff https://github.com/Andrer757/Kickoff-V2.git
brew install kickoff

Option C: Build from Source (Monorepo)

git clone https://github.com/Andrer757/Kickoff-V2.git
cd Kickoff-V2
./gradlew :kickoff-cli:installDist

2. Scaffold a New Project

Note: If running from a monorepo checkout instead of a global binary install, use ./kickoff in place of kickoff.

Scaffold an Android Application (Default)

kickoff new \
  --name "Crypto Tracker" \
  --package "com.example.cryptotracker" \
  --output "~/projects/crypto-tracker"

Scaffold a Redistributable Android SDK + Sample App

kickoff new \
  --name "Payment SDK" \
  --package "com.example.paymentsdk" \
  --type sdk \
  --output "~/projects/payment-sdk"

3. Build & Verify Generated App

cd ~/projects/crypto-tracker
./gradlew assembleDebug
./gradlew check

Full CLI Command Suite

Kickoff provides a full suite of commands for Day-1 scaffolding and Day-2 codebase evolution:

Usage: kickoff [<options>] <command> [<args>]...

Commands:
  new          Scaffold a new Android App or SDK project
  add          Add new features, modules, or database entities to an existing project
  arch-check   Sub-100ms static Clean Architecture & SDK boundary verification
  doctor       Diagnose developer environment, JDK, Android SDK, and AI tools
  mcp          Run Kickoff as a Model Context Protocol (MCP) stdio server

1. `kickoff new`

Options:
  -n, --name=<text>      Project name (Required, e.g. "Fitness App")
  -p, --package=<text>   Application package name (Required, e.g. "com.example.fitness")
  -o, --output=<text>    Target output directory (Defaults to sanitized project name)
  --type=<app|sdk>       Project archetype: app (Now-in-Android), sdk (Android SDK + Sample) (Default: app)
  -t, --template=<text>  Path to custom template
  --min-sdk=<int>        Minimum SDK API level (Default: 26)
  --target-sdk=<int>     Target SDK API level (Default: 35)
  --ai=<text>            Target AI environment: copilot, claude, cursor, generic, all, none (Default: all)
  --git / --no-git       Initialize git repository with initial commit (Default: true)
  --json                 Output result as structured machine-readable JSON

2. `kickoff add feature`

Auto-generates a new feature module and wires it into settings.gradle.kts, app/build.gradle.kts, and MainActivity.kt's NavHost:

kickoff add feature --name settings

3. `kickoff add module`

Scaffolds a :core:<name> module in an App project or :sdk-<name> in an SDK project:

kickoff add module --name analytics --type core
kickoff add module --name telemetry --type sdk

4. `kickoff add entity`

Scaffolds a domain model, Room @Entity, @Dao, and offline-first repository across :core:model, :core:database, and :core:data:

kickoff add entity --name Article --fields "id:String,title:String,content:String"

5. `kickoff arch-check`

Validates Clean Architecture module boundaries without needing a Gradle daemon:

kickoff arch-check

6. `kickoff doctor`

Diagnoses JDK, Android SDK, Gradle wrapper, and AI tools:

kickoff doctor [--json]

7. `kickoff mcp`

Launches the built-in stdio Model Context Protocol (MCP) server exposing tools directly to Claude Code, Cursor, Antigravity, and Windsurf:

kickoff mcp

Configure in Claude Desktop / Cursor / Antigravity (mcpServers):

{
  "mcpServers": {
    "kickoff": {
      "command": "kickoff",
      "args": ["mcp"]
    }
  }
}

(Or specify /path/to/Kickoff-V2/kickoff if running directly from a monorepo checkout).

Generated Architectures

1. Now-in-Android Application Architecture (`--type app`)

Scaffolded applications strictly follow Google's official Now in Android Clean Architecture design:

graph TD
    App[":app (Root, Navigation, MainActivity)"]
    FeatureHome[":feature:home (Screens, ViewModels, UI State)"]
    CoreData[":core:data (OfflineFirstUserRepository)"]
    CoreTesting[":core:testing (Test Fakes & Rules)"]
    CoreStorage[":core:database & :core:datastore"]
    CoreNetwork[":core:network (Retrofit, OkHttp)"]
    CoreCommon[":core:common (Dispatchers, AppResult)"]
    CoreConnectivity[":core:connectivity (NetworkMonitor Flow)"]
    CoreAnalytics[":core:analytics (AnalyticsHelper)"]
    CorePermissions[":core:permissions (Compose launchers)"]
    CoreDesignSystem[":core:designsystem (M3 Theme & Tokens)"]
    CoreUI[":core:ui (Shared Compose Layouts)"]
    CoreModel[":core:model (Domain Entities)"]

    App --> FeatureHome
    App --> CoreDesignSystem
    FeatureHome --> CoreModel
    FeatureHome --> CoreData
    FeatureHome --> CoreDesignSystem
    FeatureHome --> CoreUI
    CoreData --> CoreModel
    CoreData --> CoreStorage
    CoreData --> CoreNetwork
    CoreData --> CoreCommon
    CoreTesting --> CoreData

2. Android SDK Architecture (`--type sdk`)

Scaffolded SDK suites provide a redistributable, binary-compatible library setup with an interactive showcase app:

graph TD
    SampleApp[":sample (Showcase Application)"]
    SdkUi[":sdk-ui (Optional Compose Components, @Immutable)"]
    SdkCore[":sdk-core (Headless Engine, explicitApi, Zero-Hilt)"]
    SdkTesting[":sdk-testing (Consumer Test Fakes & Rules)"]

    SampleApp --> SdkUi
    SampleApp --> SdkCore
    SdkUi --> SdkCore
    SdkTesting --> SdkCore

Contributing

Kickoff is an open-source project and welcomes contributions from the community! Check out our Contributing Guide for instructions on setting up your local environment, running tests, and opening Pull Requests.

License

This project is licensed under the MIT License.

Name		Name	Last commit message	Last commit date
.agents/skills/kickoff-scaffold		.agents/skills/kickoff-scaffold
.github		.github
Formula		Formula
docs		docs
gradle/wrapper		gradle/wrapper
kickoff-cli		kickoff-cli
quality-verifier		quality-verifier
templates		templates
.gitignore		.gitignore
ACCESSIBILITY.md		ACCESSIBILITY.md
AGENTS.md		AGENTS.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE.md		LICENSE.md
README.md		README.md
SECURITY.md		SECURITY.md
build.gradle.kts		build.gradle.kts
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
install.sh		install.sh
kickoff		kickoff
settings.gradle.kts		settings.gradle.kts

Navigation Menu

Repository navigation

About

Repository files navigation

Kickoff

Documentation Index

Monorepo Architecture

Quickstart

Prerequisites

1. Install Kickoff CLI

Option A: One-Command Binary Installer (Linux & macOS)

Option B: Homebrew

Option C: Build from Source (Monorepo)

2. Scaffold a New Project

Scaffold an Android Application (Default)

Scaffold a Redistributable Android SDK + Sample App

3. Build & Verify Generated App

Full CLI Command Suite

1. `kickoff new`

2. `kickoff add feature`

3. `kickoff add module`

4. `kickoff add entity`

5. `kickoff arch-check`

6. `kickoff doctor`

7. `kickoff mcp`

Generated Architectures

1. Now-in-Android Application Architecture (`--type app`)

2. Android SDK Architecture (`--type sdk`)

Contributing

License

About

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

Kickoff

Documentation Index

Monorepo Architecture

Quickstart

Prerequisites

1. Install Kickoff CLI

Option A: One-Command Binary Installer (Linux & macOS)

Option B: Homebrew

Option C: Build from Source (Monorepo)

2. Scaffold a New Project

Scaffold an Android Application (Default)

Scaffold a Redistributable Android SDK + Sample App

3. Build & Verify Generated App

Full CLI Command Suite

1. kickoff new

2. kickoff add feature

3. kickoff add module

4. kickoff add entity

5. kickoff arch-check

6. kickoff doctor

7. kickoff mcp

Generated Architectures

1. Now-in-Android Application Architecture (--type app)

2. Android SDK Architecture (--type sdk)

Contributing

License

About

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

1. `kickoff new`

2. `kickoff add feature`

3. `kickoff add module`

4. `kickoff add entity`

5. `kickoff arch-check`

6. `kickoff doctor`

7. `kickoff mcp`

1. Now-in-Android Application Architecture (`--type app`)

2. Android SDK Architecture (`--type sdk`)