pom-cli 🪄

pom-cli lets you quickly create a pom.xml file as well as update it without manually editing the file. It's written in Java and compiled to native code with the help of graalvm.

Installation

Unix-like

Run the following script:

curl -s https://raw.githubusercontent.com/andirady/pom-cli/refs/heads/main/install.sh | bash

MacOS, Windows

Download the binaries from the Releases page.

Docker

You can also run pom-cli using Docker:

docker run --rm -it --user $(id -u):$(id -g) -v $PWD:/workspace ghcr.io/andirady/pom-cli [ARGS...]

Usage

Setting project ID

$ pom id com.example:my-app
jar com.example:my-app:0.0.1-SNAPSHOT
$ pom id com.example:my-app:1.0.0
jar com.example:my-app:1.0.0
$ pom id com.example:my-webapp --as=war
war com.example:my-webapp:0.0.1-SNAPSHOT

Set artifact ID to current directory name

$ cd my-app
$ pom id .
jar unnamed:my-app:0.0.1-SNAPSHOT
$ pom id com.example:.
jar com.example:my-app:0.0.1-SNAPSHOT
$ pom id com.example:.:1.0.0
jar com.example:my-app:1.0.0

By default, if the groupd_id is not specified, unnamed will be used. To set a different default group_id you can set the POM_CLI_DEFAULT_GROUP_ID environment variable.

$ export POM_CLI_DEFAULT_GROUP_ID=com.example
$ cd my-app
$ pom id .
jar com.example:my-app:0.0.1-SNAPSHOT

If the current folder belongs to a multi-module maven project, the <parent> element will be added to the pom. For example:

$ cd hello
$ pom id --as=pom com.example:.
pom com.example:hello:0.0.1-SNAPSHOT
$ mkdir api
$ cd $_
$ pom id hello-api
jar com.example:hello-api:0.0.1-SNAPSHOT

If the project is meant to be standalone, then you can use the --standalone flag

$ mkdir hello/sample
$ cd $_
$ pom id --standalone .
jar unnamed:sample:0.0.1-SNAPSHOT

The resulting pom.xml will not have the <parent> element.

Adding dependencies

# Add compile dependency
pom add info.picocli:picocli

# Add scoped dependency
pom add --test org.junit.jupiter:junit-jupiter
pom add --provided org.junit.jupiter:junit-jupiter
pom add --runtime org.junit.jupiter:junit-jupiter

# Add from maven metadata in a jar file
pom add /path/to/file.jar

# Add by path to maven module
pom add /path/to/module
pom add /path/to/module/pom.xml

For projects that are packaged as "pom", the dependencies will be added to the dependencyManagement section.

If version is not specified, the latest version of the artifact will be used. If there is a parent pom, and it already included the dependency version, no version will be added.

If the pom.xml is a child pom, dependency can be added by just specifying the artifact ID. For example, if the parent pom contains the following declaration:

  <dependencyManagement>
    <dependencies>
      ...
      <dependency>
        <groupId>com.example</groupId>
        <artifactId>some-api</artifactId>
        <version>1.0.0</version>
      </dependency>
      ...
    </dependencies>
  </dependencyManagement>

Running the following:

pom add some-api

would results in the target pom.xml to contain the following:

  <dependencies>
    ...
    <dependency>
      <groupId>com.example</groupId>
      <artifactId>some-api</artifactId>
    </dependency>
    ...
  </dependencies>

You can also add by just specifying the artifact ID if the artifact is managed by either in the dependencyManagement, dependency with import scope, or managed by the parent.

Removing dependencies

Dependencies can be removed from the pom.xml using the remove command.

# Remove by spefifying the groupId and artifactId
pom remove groupId:artifactId

# Remove by specifying the artifactId
pom remove artifactId

# Use the shorter alias, rm
pom rm artifactId

Setting parent POM

You can set the parent POM for your project using either a path to an existing parent project or by specifying the Maven coordinates.

If you set a parent, subsequent commands (such as pom add or pom plug) will properly manage dependencies and plugins according to the parent POM’s configuration.

Set parent by local path

# Parent is parent directory
pom parent ..
# Parent is in another directory of the parent directory
pom parent ../parent
# Parent is in a separate directory tree
pom parent /path/to/parent

This will set the <parent> element in your pom.xml to reference the specified parent project's POM file. If the version of the parent was updated, calling this again will update the <version> of the <parent>.

Set parent by Maven coordinates:

# Use latest version
pom parent groupId:artifactId
# Use specific version
pom parent groupId:artifactId:version

This will set the <parent> element in your pom.xml using the given group ID, artifact ID, and version.

Setting properties

# Set single property
pom set maven.compiler.source=17

# Set multiple properties
pom set maven.compiler.source=17 maven.compiler.source=17

# Set multiple properties leveraging shell expansion
pom set maven.compiler.{source,target}=17

Reading properties

# Get property from default profile
pom get maven.compiler.source

# Set property from specific profile
pom -P test get maven.compiler.source

Removing properties

# Remove from default profile
pom unset property_name

# Remove from specific profile
pom -P test unset property_name

Search

# Search by artifact ID
pom search log4j-api

# Search artifacts by class name
pom search --class Logger
pom search -c Logger

# Search artifacts by fully qualified class name
pom search --full-class org.apache.logging.log4j.Logger
pom search -fc org.apache.logging.log4j.Logger

Add plugin

$ # Add using full coordinate
$ pom plug com.example:hello-maven-plugin:1.0.0
🔌 com.example:hello-maven-plugin:1.0.0 plugged
$ # Auto resolve latest version
$ pom plug org.graalvm.buildtools:native-maven-plugin
🔌 org.graalvm.buildtools:native-maven-plugin:1.0.0 plugged
$ # Plug to profile
$ pom -Pnative plug org.graalvm.buildtools:native-maven-plugin
🔌 org.graalvm.buildtools:native-maven-plugin:1.0.0 plugged
$ # Add built-in plugin and auto resolve the latest version
$ pom plug maven-resources-plugin
🔌 org.apache.maven.plugins:maven-resources-plugin:1.0.0 plugged

If the current POM is a child of another POM, you can add a plugin by simply stating the plugin's artifact ID.

$ # Add plugin managed by parent
$ pom plug spring-boot-maven-plugin
🔌 org.springframework.boot:spring-boot-maven-plugin:1.0.0 plugged

or, if you're starting with an empty project, you can run

pom parent parent.group:parent.artifactId:1.0.0 plug example-maven-plugin

e.g.:

pom parent org.springframework.boot:spring-boot-starter-parent plug spring-boot-maven-plugin

Building

This project requires Java 21+, GraalVM CE and Maven 3.8.4+. You can use sdkman to download them.

To build, run

mvn -Pnative