Skip to content

Hint on cds-dk as design-time only package. #2603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chgeo merged 3 commits into from
Jun 2, 2026
+5 −1
Merged

Hint on cds-dk as design-time only package. #2603

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20c4f57
Hint on `cds-dk` as design-time only package.
chgeo Jun 1, 2026
0d7c68a
Apply suggestions from code review
chgeo Jun 2, 2026
77a5d47
Merge branch 'main' into cdsdk
chgeo Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion tools/apis/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This guide is about programmatic CDS design-time APIs.
The design-time APIs are provided with package `@sap/cds-dk` which needs to be installed locally in your project:

```sh
npm add @sap/cds-dk
npm add @sap/cds-dk --save-dev
```

That given, you can use the APIs in your project like this:
Expand All @@ -21,6 +21,10 @@ const cds = require('@sap/cds-dk')
cds.import(...)
```

> [!important] Don't load cds-dk code at runtime
> Note that `@sap/cds-dk` is a design-time dependency that runs locally or in continuous integration (CI) pipelines.
> Avoid loading the previously shown code at application runtime in deployed applications.

<script setup>
import { data as pages } from './index.data.ts'
</script>
Expand Down
Loading