Preparation to Start

Prerequisites

Before you begin, ensure you have the following:

Java Development Kit (JDK):
Java 8 or higher (as specified in your project’s pom.xml).
Learn more about installing the JDK.
Maven:
Version 3.6.0 or higher is recommended.
Official Maven Installation Guide
Maven Getting Started Guide
Internet Access:
Required for downloading dependencies and, if using GenAI features, for API access.
GW Maven Plugin Artifact:
The plugin should be available in your Maven repository or as a direct JAR download.
Learn more about Maven plugins

Project Structure

Your project should follow a standard Maven layout:

project-root/
├── pom.xml
├── src/
│   ├── main/
│   │   ├── java/
│   │   └── resources/
│   └── test/
│       ├── java/
│       └── resources/
└── ...

If you use a multi-module Maven project, ensure all modules are properly defined in the parent pom.xml:

project-root/
├── pom.xml                # Parent POM
├── module-a/
│   └── pom.xml            # Module A POM
├── module-b/
│   └── pom.xml            # Module B POM
└── ...

In the parent pom.xml, list all modules in the <modules> section:

<modules>
  <module>module-a</module>
  <module>module-b</module>
  <!-- Add additional modules here -->
</modules>

This structure allows Maven to build and manage all modules as part of a single project, supporting efficient dependency management and consistent build processes across your codebase.

Configuration

Adding the GW Maven Plugin to Your `pom.xml`

To enable Ghostwriter functionality in your Maven project, add the GW Maven Plugin to the <plugins> section of your pom.xml.
You can also specify configuration options to customize the plugin’s behavior:

<build>
  <plugins>
    <plugin>
      <groupId>org.machanism.machai</groupId>
      <artifactId>gw-maven-plugin</artifactId>
      <version>1.0.0</version>
      <configuration>
        <model>CodeMie:gpt-5-2-2025-12-11</model>
        <serverId>CodeMie</serverId>
        <logInputs>true</logInputs>
        <threads>true</threads>
        <scanDir>src/main/java</scanDir>
        <instructions>file:instructions.txt</instructions>
        <excludes>
          <exclude>logs</exclude>
        </excludes>
      </configuration>
    </plugin>
  </plugins>
</build>

Defining the OSS Sonatype Maven Central Repository

To ensure Maven can always retrieve the latest version of the GW Maven Plugin, add the OSS Sonatype repository to your <repositories> section in your pom.xml:

<repositories>
  <repository>
    <id>plugin-oss</id>
    <url>https://oss.sonatype.org/content/repositories/releases/</url>
    <releases>
      <enabled>true</enabled>
    </releases>
    <snapshots>
      <enabled>false</enabled>
    </snapshots>
  </repository>
</repositories>

This configuration allows Maven to download plugin releases directly from the OSS Sonatype repository, which hosts artifacts before they are fully synchronized to Maven Central. This is especially useful for accessing the latest plugin versions that may not yet be available in Maven Central.

Tip:
Always check Maven Central for the most recent stable plugin versions. If you need a version that is not yet available there, the OSS Sonatype repository will provide access.

Maven Settings Integration:

If you specify <serverId>, the plugin will look up credentials in your Maven settings.xml under the corresponding <server> entry.

Example settings.xml entry:

<server>
  <id>CodeMie</id>
  <username>your-genai-username</username>
  <password>your-genai-password</password>
	<configuration>
		<AUTH_URL>codemie-auth-url</AUTH_URL>
	</configuration>
</server>

Notes:

Make sure to use the latest available version of the plugin. Check Maven Central for updates.
For more information on configuring Maven plugins, see the Maven Plugin Configuration Guide.
For multi-module projects, add the plugin to the parent POM or to the specific module(s) where you want to enable Ghostwriter processing.