Skip to main content
The Lumo UI plugin provides a set of CLI commands to initialize, configure, and manage UI components in your project.

​
Command Syntax

All Lumo commands follow this pattern: 
./gradlew lumo --<command> [arguments]

​
Available Commands

init

Initialize the Lumo UI plugin in your project

setup

Setup theme and verify configuration

add

Add a specific UI component

add-all

Add all available UI components

required-deps

Show required dependencies

available-components

List all available components

​
Quick Reference

CommandDescription
--initCreates default configuration file
--setupGenerates theme files and validates config
CommandDescription
--add <name>Add a specific component by name
--add-allAdd all available components
--available-componentsList all component names
CommandDescription
--required-depsDisplay required Gradle dependencies
--plugin-helpShow help message

​
Typical Workflow

Here’s the recommended sequence for setting up Lumo UI: 
# 1. Initialize the plugin
./gradlew lumo --init

# 2. Configure lumo.properties file
# Edit the generated file with your project details

# 3. Check required dependencies
./gradlew lumo --required-deps

# 4. Add dependencies to build.gradle.kts
# Copy the output from step 3

# 5. Setup theme
./gradlew lumo --setup

# 6. Add components as needed
./gradlew lumo --add Button
./gradlew lumo --add Card

​
Configuration File

Most commands require a valid lumo.properties file in your project root. This file is created by the --init command and contains:
​
ThemeName
string
required
Name of your application theme (e.g., AppTheme)
​
ComponentsDir
string
required
Relative path from project root to components directory
​
PackageName
string
required
Package name for generated component files
​
KotlinMultiplatform
boolean
default:"false"
Set to true for Kotlin Multiplatform projects

​
Error Handling

If you run a command without providing any options, you’ll get an error:
No input provided, run with --plugin-help for more information
Use ./gradlew lumo --plugin-help to see the built-in help message at any time.

​
Next Steps

Build docs developers (and LLMs) love

Get started for freeTalk to us