Codex Java Template

Java + Gradle starter with:

• SLF4J API + Logback for logging
• Javadoc and inline comment/TODO conventions
• Codex agents to manage docs and code quality
• Spotless and Checkstyle

Requirements

• JDK 17+
• Gradle 8+ (wrapper included)

Quick start

./gradlew run
./gradlew spotlessApply check

Project layout

.
├── codex/                 # Agents, conventions, prompts
├── src/main/java/         # Source
├── src/test/java/         # Tests
├── build.gradle           # Build
└── config/                # Tooling configs (checkstyle, etc.)

Git hook (optional)

# Install pre-commit to format and run checks locally
chmod +x scripts/pre-commit
ln -sf ../../scripts/pre-commit .git/hooks/pre-commit

git clone https://github.com/<your-username>/codex-java-template my-new-project

Notes

• Use @DocGuardian in your Codex workflow to scan and fix Javadoc.
• Use @CodeGuardian to enforce style and run spotless + checkstyle automatically.