onedevatlasBeta
Browse the atlas
AllCAPUI5ABAPBTP
Build toolBuild tooltypeRuns at build time. Nothing of it ships in the deployed application.See every one →What this type is →by SAPby SAPoriginPublished by SAP itself. A visible facet, never an input to a reading — a dormant official plugin reads exactly like a dormant independent one.See every one →

com.sap.cds:cds-maven-plugin

The Maven plugin that runs CDS build steps in a CAP Java project: compiling the model, generating typed Java accessor interfaces and adding facets to an existing project.

Runs the CDS build steps inside a Maven build for a project in the cds-services-bom release line. It can install Node.js and the @sap/cds-dk development kit in a pinned version, run arbitrary cds commands such as build and deploy, and clean a project of the previous build's generated artifacts. Its add goal expands an existing project with one feature at a time, the same goal the archetype calls with -Dfeature=CF or -Dfeature=TINY_SAMPLE right after project generation, and its generate goal turns every structured type in the CDS model into a typed Java accessor interface, in JavaBeans or fluent style. It is declared as a build plugin in pom.xml rather than as a dependency, with its version usually pinned through a property shared with the rest of the CAP Java modules.

Homepage
Docs

Facts

LicenceSAP DEVELOPER LICENSE AGREEMENT for CAP

Where it sits

Lives in
CAP
Provides
GeneratorsCAPGeneratorscapabilityGetting from nothing to a project that runs, and from a project that runs to one that has the piece you just decided you need. Two different moments: the first is a one-time decision about layout, the second recurs for the life of the project.TypingCAPTypingcapabilityMaking the model visible to the compiler — generated types for entities and events so a rename breaks the build rather than production.Local developmentCAPLocal developmentcapabilityRunning the whole stack on a laptop against real bindings — the service, the UI and the routing in front of it — without deploying to see a change.
Flavors
Java
Requires
@sap/cds-dk@sap/cds-dkartifactCompiling the CDS model to CSN needs a Node.js runtime with the @sap/cds-dk development kit, which the plugin installs and runs itself unless a global installation is used.

What it declares

Every artifact

Type
Build tool
Origin
By SAP
Runtime
Javabuild time

As a build tool

Distributed through
does not say

For local development

Part of the local stack it starts
CAP service

Tasks this contributes to2Beta

Local development2
Pick up a CDS model change without restarting by handA developer edits a CDS file or a handler and the running service answers the next request against the changed model, without stopping and starting it.Node.js, JavaCovers, under conditionsthe watch loop (Java)
What it does

The watch goal runs the CDS build and starts the application, and with Devtools on the project it takes advantage of their reload mechanism, where any change reloads the application context instead of restarting the whole application.

Conditions

Spring Boot Devtools are on the project, without which the goal performs a complete restart of the application after a CDS model change, which capire calls slower; on Windows the watch goal only works if the Spring Boot Devtools are enabled

Remaining work

Add the Devtools dependency, and the plugin group com.sap.cds to ~/.m2/settings.xml for the short mvn cds:watch form. Devtools detects changes to .class files only, so a change to Java code is picked up once the build has produced them.

All options on the Local development page →
Start a CAP service with nothing boundA CAP project whose model imports a remote service and whose endpoints are authenticated starts, serves and answers requests on a laptop with no service instance bound, no database provisioned and no upstream system reachable.Node.js, JavaCoversthe command that starts it (Java)
What it does

The watch goal runs the CDS build and starts the application, which is how a Java project gets from a checked-out model to a served endpoint without a deployment.

Remaining work

Add the plugin group com.sap.cds to ~/.m2/settings.xml for the short mvn cds:watch form, and generate the SQLite or H2 schema in the build where the local database needs one.

All options on the Local development page →

Connections4

Download
com.sap.cds:cds-maven-plugin connectionscom.sap.cds:cds-maven-pluginPROVIDES→ provides3provides stated Adds the add goal, which expands an existing CAP Java project with one feature at a time, such as Cloud Foundry support or a tiny sample model, by editing the project's pom.xml and other configuration files. Building Applications: https://cap.cloud.sap/docs/java/developing-applications/building#maven-build-options Getting Started: https://cap.cloud.sap/docs/java/getting-started#run-the-cap-java-maven-archetypeGeneratorsprovides stated The watch goal, mvn cds:watch, does the CDS build and can start the application, the Java counterpart of cds watch. With Spring Boot Devtools on the project it takes advantage of their reload mechanism; without them it performs a complete restart of the application after a CDS model change, which capire calls slower, and on Windows the goal only works if they are enabled. Running Applications (CAP Java) — capire: https://cap.cloud.sap/docs/java/developing-applications/running Running Applications (CAP Java) — capire, watch goal: https://cap.cloud.sap/docs/java/developing-applications/running Running Applications (CAP Java) — capire, the reload mechanism: https://cap.cloud.sap/docs/java/developing-applications/running Running Applications (CAP Java) — capire, without Devtools: https://cap.cloud.sap/docs/java/developing-applications/running Running Applications (CAP Java) — capire, Windows: https://cap.cloud.sap/docs/java/developing-applications/runningLocal developmentprovides stated Adds the generate goal, which compiles every structured type in the CDS model into a typed Java accessor interface at build time, in JavaBeans or fluent style. Working with CDS Data: https://cap.cloud.sap/docs/java/cds-data Building Applications: https://cap.cloud.sap/docs/java/developing-applications/building#maven-build-optionsTypingNEEDS→ needs1needs stated Compiling the CDS model to CSN needs a Node.js runtime with the [@sap/cds-dk](artifact:sap-cds-dk) development kit, which the plugin installs and runs itself unless a global installation is used. Building Applications: https://cap.cloud.sap/docs/java/developing-applications/building@sap/cds-dk

Others providing24

Generators
  1. SAP Build CodeDevelopment environment on BTP for UI5, Fiori, mobile and CAP
  2. @cap-handler/generatorInteractive generator for CAP event handler files
  3. com.sap.cds:cds-services-archetypeMaven archetype generating a new CAP Java project
  4. @khalidmh/capxInteractive project installer for CAP Node.js
  5. Joule in SAP Build CodeJoule's generative AI inside SAP Build Code
  6. @sap/cds-dkCommand line client and development toolkit for CAP
  7. @sap/generator-cap-projectCAP project generator behind SAP Business Application Studio's wizard
  8. @sap/generator-cdsCDS project generator, deprecated in favour of @sap/cds-dk
  9. @sap-ux/cap-config-writerWriter module for changing a CAP project's configuration from code
  10. @sap-ux/createCommand line for changing features of an existing Fiori project
  11. @sap-ux/fe-fpm-writerWriter of flexible programming model elements into Fiori elements apps
  12. @sap-ux/fiori-generator-sharedShared functions and types of the Fiori generators
  13. @sap-ux/odata-service-writerWriter that adds an OData service to an existing UI5 project
Typing
  1. @cap-js/cds-typerGenerates TypeScript types from a CDS model
  2. @cap-js/cds-typesType definitions for the CAP Node.js SDK
  3. cds-internal-toolReusable internals for authors of CAP extensions
Local development
  1. vite-plugin-cdsServes a Vite app through cds watch and imports .cds files
  2. com.sap.cds:cds-feature-dev-dashboardBrowser dashboard for a running CAP Java service during development
  3. @cap-js-community/commonSix CAP features in one package, from replication cache to rate limits
  4. @neoimpulse/cap-js-bootstrapCLI starting several CAP services and an AppRouter locally together
  5. @sang2x/captoolsCLI of CAP development tools for Cloud Foundry workflows
  6. @sap/ams-devCompiler from AMS DCL policies to DCN for local runs and tests
  7. @sap/cds-dkCommand line client and development toolkit for CAP
  8. @sap/cdsCAP Node.js runtime
  9. dev-approuterDev-time wrapper for the SAP Application Router

Details

Sources1
Added by handdiscovered herechecked

Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.

Compatibility and provenance
runtimesjava, build-time
discovered viaAdded by hand
first seen in the atlas
ecosystem and domaincap, developer-experience
Flavors1
Java
“Maven Plugin for CDS Services Java” — com.sap.cds:cds-maven-plugin — Maven POMchecked
History in the atlas4
  1. The same goal with the three conditions capire states: the Devtools reload mechanism, the complete restart without them, and the Windows requirement.
  2. Adds the add goal, which expands an existing CAP Java project with one feature at a time, such as Cloud Foundry support or a tiny sample model, by editing the project's pom.xml and other configuration files.
  3. Adds the generate goal, which compiles every structured type in the CDS model into a typed Java accessor interface at build time, in JavaBeans or fluent style.
  4. First seen.
For your agent
Ref
artifact:cap-java-cds-maven-plugin
JSON
/artifacts/cap-java-cds-maven-plugin.json
MCP
Connecting an agent