agentleFS
Sign inStart free
codecentriccodecentric/spring-boot-admin/.github/copilot-instructions.md

spring-boot-admin

Copilot instructions13k starsChanged 5 months agoApache-2.0View on GitHub

Always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here.

We split this copilot-instructions.md into the rules it gives an agent

17 rules. About 0 are common, 8 are distinctive, and 9 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 9

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does …

    line 4
  2. Very specific:

    Verify versions: java -version (should show 17.x) and node --version (should show v22.18.0)

    line 13
  3. Very specific:

    Check Java formatting: ./mvnw spring-javaformat:validate

    line 30
  4. Very specific:

    ALWAYS: run ./mvnw spring-javaformat:apply and UI formatting before committing

    line 33
  5. Very specific:

    ALWAYS: run ./mvnw checkstyle:check to verify compliance

    line 34
  6. Very specific:

    Run servlet sample: cd spring-boot-admin-samples/spring-boot-admin-sample-servlet && export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH" …

    line 38
  7. Distinctive:

    MANUAL VALIDATION REQUIRED: After building and running, always test actual functionality

    line 53
  8. Very specific:

    Verify application registration: Should show "spring-boot-admin-sample-servlet" with UP status

    line 55
  9. Distinctive:

    Test navigation: Click on Applications, Wallboard, and instance details

    line 56
  10. Distinctive:

    Check endpoints: Verify actuator endpoints are detected and accessible

    line 57
  11. Distinctive:

    Test monitoring features: Instance details should show health, metrics, loggers, etc.

    line 58
  12. Very specific:

    Initial Build: Run ./mvnw clean compile to verify everything builds (~10.5 minutes - be patient)

    line 103
  13. Very specific:

    Install Dependencies: Run ./mvnw install -DskipTests for sample app dependencies (~1.5 minutes)

    line 104
  14. Very specific:

    Format Code: Run ./mvnw spring-javaformat:apply and UI npm run format:fix

    line 106
  15. Distinctive:

    Test Build: Run build commands to verify changes don't break anything

    line 107
  16. Distinctive:

    Manual Validation: Start sample application and test UI functionality

    line 108
  17. Distinctive:

    Final Check: Ensure formatting and linting pass before committing

    line 109

≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

Spring Boot Admin

Spring Boot Admin is a multi-module Maven project providing an admin interface for Spring Boot applications that expose actuator endpoints. It consists of a Vue.js frontend and Java backend components with 19 Maven modules.

Always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here.

Working Effectively

Prerequisites and Environment Setup

  • Install Java 17 (OpenJDK Temurin 17.0.16+ recommended) - project requires exactly Java 17
  • Install Node.js 22.18.0 exactly (project specifies this in .nvmrc and package.json)
  • Download Node.js 22.18.0: curl -fsSL https://nodejs.org/dist/v22.18.0/node-v22.18.0-linux-x64.tar.xz -o /tmp/node.tar.xz
  • Extract and configure PATH: cd /tmp && tar -xf node.tar.xz && export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH"
  • Verify versions: java -version (should show 17.x) and node --version (should show v22.18.0)

Building the Project

  • NEVER CANCEL builds - they take time but will complete successfully
  • CRITICAL: Set timeout to 20+ minutes for builds, 60+ minutes for tests
  • Clean compile: export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH" && ./mvnw clean compile -B --no-transfer-progress -DskipTests -- takes ~10.5 minutes
  • Full package: export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH" && ./mvnw package -B --no-transfer-progress -DskipTests -- takes ~4 minutes
  • Install to local repository: export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH" && ./mvnw install -B --no-transfer-progress -DskipTests -- takes ~1.5 minutes

Testing

  • NEVER CANCEL test runs - set 60+ minute timeouts
  • Full test suite: export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH" && ./mvnw test -B --no-transfer-progress -- takes 20-40 minutes
  • UI tests only: cd spring-boot-admin-server-ui && export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH" && npm run test -- takes ~44 seconds
  • UI build only: cd spring-boot-admin-server-ui && export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH" && npm run build -- takes ~16 seconds

Code Quality and Formatting

  • Format Java code: ./mvnw spring-javaformat:apply
  • Check Java formatting: ./mvnw spring-javaformat:validate
  • Lint UI code: cd spring-boot-admin-server-ui && npm run lint
  • Format UI code: cd spring-boot-admin-server-ui && npm run format:fix
  • ALWAYS run ./mvnw spring-javaformat:apply and UI formatting before committing
  • ALWAYS run ./mvnw checkstyle:check to verify compliance

Running Sample Applications

  • Build and install all modules first: export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH" && ./mvnw install -B --no-transfer-progress -DskipTests
  • Run servlet sample: cd spring-boot-admin-samples/spring-boot-admin-sample-servlet && export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH" && ../../mvnw spring-boot:run -Dspring-boot.run.profiles=dev,insecure
  • Access UI at: http://localhost:8080 (username: user, password shown in logs or use insecure profile)
  • Application starts in ~3 seconds and shows "all up" status with registered instance

UI Development Mode

  • For UI development: cd spring-boot-admin-server-ui && npm run build:watch (builds on file changes)
  • Configure Spring Boot Admin Server with:
    spring.boot.admin.ui.cache.no-cache: true
spring.boot.admin.ui.resource-locations: file:../../spring-boot-admin-server-ui/target/dist/
spring.boot.admin.ui.template-location: file:../../spring-boot-admin-server-ui/target/dist/
spring.boot.admin.ui.cache-templates: false

Validation Scenarios

  • MANUAL VALIDATION REQUIRED: After building and running, always test actual functionality
  • Launch sample application and verify Spring Boot Admin UI loads at http://localhost:8080
  • Verify application registration: Should show "spring-boot-admin-sample-servlet" with UP status
  • Test navigation: Click on Applications, Wallboard, and instance details
  • Check endpoints: Verify actuator endpoints are detected and accessible
  • Test monitoring features: Instance details should show health, metrics, loggers, etc.

Key Modules and Locations

Primary Components

  • Root: / - Main Maven reactor project (pom.xml)
  • Server Backend: spring-boot-admin-server/ - Core Spring Boot Admin server functionality
  • UI Frontend: spring-boot-admin-server-ui/ - Vue.js 3 web interface with Vite build
  • Client: spring-boot-admin-client/ - Client library for connecting applications
  • Documentation: spring-boot-admin-docs/ - Asciidoc documentation

Starter Modules

  • Server Starter: spring-boot-admin-starter-server/ - Auto-configuration for servers
  • Client Starter: spring-boot-admin-starter-client/ - Auto-configuration for clients

Sample Applications (in spring-boot-admin-samples/)

  • servlet: Standard servlet-based sample (recommended for testing)
  • reactive: WebFlux reactive sample
  • eureka: Eureka discovery integration
  • consul: Consul discovery integration
  • hazelcast: Hazelcast session management
  • war: WAR deployment sample
  • zookeeper: Zookeeper discovery integration

Infrastructure

  • Dependencies: spring-boot-admin-dependencies/ - Dependency management BOM
  • Build: spring-boot-admin-build/ - Build configuration and tooling
  • Server Cloud: spring-boot-admin-server-cloud/ - Spring Cloud integrations

Common Issues and Solutions

Build Issues

  • Node.js version mismatch: Always use exact PATH override with v22.18.0
  • Missing dependencies: Run ./mvnw install to install all modules to local Maven repository
  • Checkstyle violations: Run ./mvnw spring-javaformat:apply to auto-fix formatting
  • UI build failures: Verify Node.js version and run npm install in spring-boot-admin-server-ui/
  • "Command timed out": Increase timeout - builds legitimately take 10+ minutes

Runtime Issues

  • Sample app dependency resolution: Must run ./mvnw install first to populate local repository
  • Config server connection refused: Normal warning, config server is optional in dev mode
  • Security warnings: Use insecure profile for development to bypass authentication

Development Workflow

  1. Setup: Configure Node.js 22.18.0 in PATH: export PATH="/tmp/node-v22.18.0-linux-x64/bin:$PATH"
  2. Initial Build: Run ./mvnw clean compile to verify everything builds (~10.5 minutes - be patient)
  3. Install Dependencies: Run ./mvnw install -DskipTests for sample app dependencies (~1.5 minutes)
  4. Make Changes: Edit code in appropriate modules
  5. Format Code: Run ./mvnw spring-javaformat:apply and UI npm run format:fix
  6. Test Build: Run build commands to verify changes don't break anything
  7. Manual Validation: Start sample application and test UI functionality
  8. Final Check: Ensure formatting and linting pass before committing

Critical Timing Information

  • NEVER CANCEL: Build commands take significant time but complete successfully
  • Clean compile: ~10.5 minutes (normal, expected)
  • Package build: ~4 minutes
  • Install build: ~1.5 minutes
  • Full test suite: 20-40 minutes (set 60+ minute timeout)
  • UI tests only: ~44 seconds
  • UI build only: ~16 seconds
  • Application startup: ~3 seconds

Technology Stack

  • Backend: Spring Boot 3.5, Java 17, Maven multi-module
  • Frontend: Vue.js 3, Vite, TypeScript, Tailwind CSS
  • Testing: JUnit 5 (Java), Vitest (UI), Playwright integration
  • Build: Maven 3.9+, Node.js 22.18.0, npm
  • Code Quality: Spring Java Format, Checkstyle, ESLint, Prettier

Repository Structure Overview

spring-boot-admin/                    # Root project (19 modules)
├── .github/                         # GitHub configuration
├── spring-boot-admin-build/         # Build configuration
├── spring-boot-admin-client/        # Client library
├── spring-boot-admin-dependencies/  # Dependency management
├── spring-boot-admin-docs/          # Documentation (Asciidoc)
├── spring-boot-admin-samples/       # Sample applications
│   ├── spring-boot-admin-sample-servlet/    # Main sample (recommended)
│   ├── spring-boot-admin-sample-reactive/   # WebFlux sample
│   └── [other samples]/            # Various integration samples
├── spring-boot-admin-server/        # Core server implementation
├── spring-boot-admin-server-cloud/  # Spring Cloud integrations
├── spring-boot-admin-server-ui/     # Vue.js frontend
│   ├── src/main/frontend/          # Vue.js source code
│   ├── package.json                # Node.js dependencies
│   └── .nvmrc                      # Node.js version specification
├── spring-boot-admin-starter-*/     # Spring Boot auto-configuration
├── mvnw                            # Maven wrapper
└── pom.xml                         # Root Maven configuration

Download now (ZIP)

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 1 mentionMar 2026: 0 mentionsApr 2026: 1 mentionMay 2026: 0 mentionsJun 2026: 1 mentionJul 2026: 1 mentionAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 4 mentionsNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the codecentric/spring-boot-admin repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about codecentric/spring-boot-admin

The biggest 5 of 81 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 81

Talked about on GitHub, Stack Overflow and the web (81 times).

On GitHub · 50

45 more on GitHub

On Stack Overflow · 29

24 more on Stack Overflow

On the web · 2

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,297 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free