iDempiere CLI - Validate and Analyze

This skill guides you through validating and analyzing iDempiere plugins using idempiere-cli.

Available Commands

Validate - Plugin Structure Check

Validates the plugin's OSGi configuration files for correctness.

# Validate current directory
idempiere-cli validate

# Validate specific plugin
idempiere-cli validate /path/to/my-plugin

# Strict mode (treat warnings as errors)
idempiere-cli validate --strict

# Quiet mode (no output on success)
idempiere-cli validate --quiet

# JSON output for CI/CD parsing
idempiere-cli validate --json

What validate checks

• •META-INF/MANIFEST.MF - OSGi bundle headers and syntax
• •build.properties - Tycho build configuration
• •pom.xml - Maven/Tycho configuration
• •OSGI-INF/*.xml - Service component descriptors
• •plugin.xml - Eclipse extension points
• •Java sources - Package structure and basic checks

Exit Codes

CI/CD Usage

# Fail build on any error
idempiere-cli validate ./my-plugin || exit 1

# Fail build on warnings too
idempiere-cli validate --strict ./my-plugin || exit 1

# Quiet mode for scripts
idempiere-cli validate --quiet ./my-plugin && echo "OK"

Info - Plugin Metadata

Displays detailed information about the plugin.

# Show plugin info
idempiere-cli info

# Specific directory
idempiere-cli info --dir=/path/to/my-plugin

# JSON output
idempiere-cli info --json

What info shows

• •Plugin ID (Bundle-SymbolicName)
• •Version (Bundle-Version)
• •Vendor (Bundle-Vendor)
• •Required bundles (Require-Bundle)
• •Detected components (callouts, processes, forms, etc.)

Deps - Dependency Analysis

Analyzes plugin dependencies by scanning Java imports and comparing with MANIFEST.MF.

# Analyze dependencies
idempiere-cli deps

# Specific directory
idempiere-cli deps --dir=/path/to/my-plugin

# JSON output
idempiere-cli deps --json

What deps reports

• •Required bundles: Bundles your plugin depends on
• •Missing bundles: Dependencies found in imports but not in MANIFEST.MF
• •Unused bundles: Bundles in MANIFEST.MF not referenced by any import

Diff-Schema - Database Schema Comparison

Compares model classes (I_/X_ generated classes) against the actual database schema.

# Compare all model classes against database
idempiere-cli diff-schema \
  --db-host=localhost \
  --db-port=5432 \
  --db-name=idempiere \
  --db-user=adempiere \
  --db-pass=adempiere

# Compare specific table only
idempiere-cli diff-schema --table=C_Order \
  --db-host=localhost \
  --db-name=idempiere \
  --db-user=adempiere \
  --db-pass=adempiere

# Use configuration file
idempiere-cli diff-schema --config=~/.idempiere-cli.yaml

What diff-schema detects

• •Missing columns: Column exists in database but not in model class
• •Extra columns: Column exists in model class but not in database
• •Type mismatches: Column type in model doesn't match database type

Diff-Schema Options

Complete Analysis Example

cd org.mycompany.myplugin

# 1. Check plugin structure
idempiere-cli validate

# 2. View plugin metadata
idempiere-cli info

# 3. Check for missing/unused dependencies
idempiere-cli deps

# 4. Verify model classes match database
idempiere-cli diff-schema --db-host=localhost --db-name=idempiere \
  --db-user=adempiere --db-pass=adempiere

Notes

• •All analysis commands work on the current directory by default.
• •JSON output (--json) is available for most commands, useful for CI/CD pipelines and scripting.
• •diff-schema requires a running database connection.
• •validate is recommended before every deploy to catch configuration issues early.