Package org.apache.maven.api.cli

package org.apache.maven.api.cli

Provides the API for Maven's command-line interface and tools.

This package contains interfaces and classes for:

• Command-line argument parsing and processing
• Maven tool invocation (mvn, mvnenc, mvnsh)
• Core extensions configuration
• Early-stage logging before the full Maven logging system is initialized

The main components are:

• Invoker - Base interface for executing Maven tools
• Parser - Processes command-line arguments into invoker requests
• Options - Represents Maven configuration options
• CoreExtensions - Manages Maven core extensions

Core extensions can be configured through .mvn/extensions.xml in the project base directory to enhance Maven's capabilities during build execution.

Since:

4.0.0

Related Packages

Package	Description
org.apache.maven.api	Maven Core API
org.apache.maven.api.cli.extensions	Provides support for Maven core extensions configuration and management.
org.apache.maven.api.cli.logging	Provides early-stage logging capabilities for Maven CLI operations.
org.apache.maven.api.cli.mvn	Provides the API for the Maven build tool (mvn).
org.apache.maven.api.cli.mvnenc	Provides the API for the Maven Password Encryption tool (mvnenc).
org.apache.maven.api.cli.mvnsh	Provides the API for the Maven Shell tool (mvnsh).

Class	Description
Executor	Defines the contract for a component responsible for executing a Maven tool using the information provided in an ExecutorRequest.
ExecutorException	Represents an exception that occurs during the execution of a Maven build or command.
ExecutorRequest	Represents a request to execute Maven with command-line arguments.
ExecutorRequest.Builder
Invoker	Defines the contract for a component responsible for invoking a Maven application using the information provided in an InvokerRequest.
InvokerException	Represents an exception that occurs during the invocation of a Maven build or command.
InvokerException.ExitException	Exception for intentional exit: No message or anything will be displayed, just the carried exit code will be returned from invoker Invoker.invoke(InvokerRequest) method.
InvokerRequest	Represents a Maven invocation request, encapsulating all necessary information for invoking a Maven build or command.
Logger	Defines a simple logging interface for Maven CLI operations.
Logger.Entry	Logger entries returned by Logger.drain() method.
Logger.Level	Represents the severity levels for log messages.
Options	Represents the base options supported by Maven tools.
Parser	Defines the contract for parsing Maven command-line arguments and creating an execution or invoker requests.
ParserRequest	Represents a request to parse Maven command-line arguments.
ParserRequest.Builder
Tools	Represents most common tools supported by CLIng.