idempiere-cli

A command-line tool for iDempiere plugin engineering, built with Quarkus and Picocli.

Status: Early release (active development). Core workflows are usable and tested, but the project is still evolving. Expect iterative improvements and occasional breaking changes.

Scope

idempiere-cli standardizes repetitive iDempiere plugin engineering tasks:

• environment checks and setup (doctor, setup-dev-env)
• scaffolding and component generation (init, add)
• quality gates (validate, deps, info)
• delivery (build, deploy, package, migrate)

It complements iDempiere runtime/Application Dictionary tooling; it does not replace them.

Operating Model

• Default/core build is deterministic and template-first.
• idempiere-cli is the engineering integrity layer: scaffold, validate, build, package, deploy.
• External agents (Claude Code, Codex, Gemini CLI, etc.) are the recommended path for iterative business logic authoring.

Install

curl -fsSL https://raw.githubusercontent.com/devcoffee/idempiere-cli/main/install.sh | bash
idempiere-cli doctor

Manual binaries: GitHub Releases
Windows prerequisite (if needed): VC++ Redistributable

Quick Start

# 1) Check/fix local prerequisites
idempiere-cli doctor --fix

# 2) Bootstrap local environment (Docker path)
idempiere-cli setup-dev-env --with-docker

# 3) Create and build first plugin
idempiere-cli init org.mycompany.myplugin
cd myplugin && ./mvnw verify

Build

• Official release target: core/default deterministic build
• Command: ./mvnw clean package

Documentation

Start from the Documentation Hub.

Practical guides:

• Onboarding in 15 Minutes
• Daily Plugin Development Loop
• Troubleshooting Guide
• Automation and Exit Codes
• Pre-Release Smoke Validation

Internal/experimental (optional):

• AI Generation Cycle

Reference:

• Core Contract (v1)
• Command Reference
• Configuration
• Build and Release
• Release Checklist
• Known Limitations
• Architecture, Scope, and Roadmap

Contributing

Contributions are welcome, especially in:

• real-world integration tests
• template quality and maintainability
• documentation and troubleshooting playbooks
• Oracle and multi-platform setup validation

License

Licensed under GNU GPL v2.0.

Acknowledgments

Built on top of:

• idempiere
• idempiere-dev-setup
• idempiere-examples