Cursor AI rules for Java

# Cursor AI rules for Java

## Stargazers over time
[![Stargazers over time](https://starchart.cc/jabrena/cursor-rules-java.svg?variant=light)](https://starchart.cc/jabrena/cursor-rules-java)

[![CI Builds](https://github.com/jabrena/cursor-rules-java/actions/workflows/maven.yaml/badge.svg)](https://github.com/jabrena/cursor-rules-java/actions/workflows/maven.yaml)

## Share feedback

```bash
╔══════════════════════════════════════════════════════════════╗
║ ┌──────────────────────────────────────────────────────────┐ ║
║ │ Tu feedback es importante para evolucionar este proyecto │ ║
║ │    Your feedback is important to evolve this project     │ ║
║ │                您的反馈对本项目的发展至关重要                 │ ║
║ │           https://forms.gle/TpNXENjmu45wuXoi6            │ ║
║ └──────────────────────────────────────────────────────────┘ ║
╚══════════════════════════════════════════════════════════════╝
```
https://forms.gle/TpNXENjmu45wuXoi6

## Goal

The project provides a collection of `System prompts` for Java Enterprise development that help software engineers in their daily programming work and pipelines.
The [available System prompts for Java](./CURSOR-RULES-JAVA.md) cover aspects like `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with Async profiler/OpenJDK tools`, `Documentation` & `Diagrams`.

### Compatibility with Modern IDEs, CLI & Others

The repository was designed to support Cursor, but other tools have evolved and now offer better support for system prompts. The repository runs regular regression tests for IDEs and tools such as *Cursor*, *Cursor CLI*, *Claude Code*, *GitHub Copilot*, and *JetBrains Junie*.

⚠️ **Note:** Currently, the best environments in which to use this repository are *Cursor*, *Cursor CLI*, and *Claude Code*. If you use *JetBrains IntelliJ IDEA*, you can combine it with *Cursor CLI* or *Claude Code*. Further information is available in the latest review [here](./documentation/reviews/review-20250829.md) (**Last update:** 2025/08/29).

## What is a System prompt?

A system prompt is a set of instructions given to an AI model that defines how it should behave, what role it should take on, and what guidelines it should follow when responding to users. Think of it as the "operating manual" that shapes the AI's personality, capabilities, and boundaries.

![](./documentation/images/prompts.png)

### Types of System prompts

The repository provides System prompts that can behave interactively or non-interactively, depending on how the user employs them.

- **System prompts:** `Create a UML class diagram with @170-java-documentation without asking questions` or `Add the Maven Enforcer plugin using the rule @112-java-maven-plugins without asking questions`
- **Interactive System Prompts:** Prompts that ask questions and include conditional logic. Examples: `Improve the pom.xml using the cursor rule @112-java-maven-plugins` or `Generate technical documentation and diagrams about the project with the cursor rule @170-java-documentation`

### Types of customized behaviours for system prompts

- **Consultative Interactive:** Prompts that suggest alternatives to improve software development. Examples: `Improve the class/classes added in the context applying the system prompt @128-java-generics with the behaviour @behaviour-consultative-interaction` or `Improve the class/classes added in the context applying the system prompt @131-java-unit-testing with the behaviour @behaviour-consultative-interaction`
- **Progressive Learning:** Using the system prompts, you can generate courses about a particular topic to better understand the changes generated by models. Example: `Create a course about @128-java-generics.md using the behavior @behaviour-progressive-learning.md and place the course in @courses`

### Java development workflow

Adding AI tools to the Java development workflow can increase the likelihood of implementing software specifications on time and with quality.

![](./documentation/images/workflow.png)

### Pipelines workflow

Adding AI tools to your pipeline can provide new opportunities to deliver more value (examples: automatic coding, code refactoring, continuous profiling, and others).

![](./documentation/images/pipeline-workflow.png)

## Getting started

New to this repository? Start with our [comprehensive guide](./documentation/GETTING-STARTED.md) for a quick introduction to setting up and using the Cursor rules, then read about [how to integrate system prompts](./documentation/HOW-TO-USE.md) into your development workflow to maximize their effectiveness in your daily coding tasks. For a full understanding of this project, follow the course [Mastering System Prompts for Java](https://jabrena.github.io/cursor-rules-java/courses/system-prompts-java/index.html).

## How many system prompts for Java does this project include?

Explore the [complete catalog of available System prompts](./

... (truncated)