Skip to content

chore: Update CLI texts #1962

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: Update CLI texts #1962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 31 additions & 15 deletions tools/assets/help/cds-add.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,29 @@
<em>typer</em> - type generation for CDS models
<em>typescript</em> - add minimum configuration for a bare TypeScript project
<em>extension</em> - Extension project
<em>tiny-sample</em> - add minimal sample files
<em>sample</em> - add sample files including Fiori UI
<em>handler</em> - handler stubs for service entities, actions and functions
<em>mta</em> - Cloud Foundry deployment using mta.yaml
<em>cf-manifest</em> - Cloud Foundry deployment using manifest files
<em>helm</em> - Kyma deployment using Helm charts
<em>helm-unified-runtime</em> - Kyma deployment using Unified Runtime Helm charts
<em>containerize</em> - containerization using ctz CLI
<em>multitenancy</em> - schema-based multitenancy support
<em>toggles</em> - allow dynamically toggled features
<em>extensibility</em> - tenant-specific model extensibility
<em>side-by-side-extensibility</em> - logic extensibility via extension points
<em>mtx</em> - multitenancy + toggles + extensibility
<em>tiny-sample</em> - add minimal sample files
<em>sample</em> - add sample files including Fiori UI
<em>handler</em> - handler stubs for service entities, actions and functions
<em>test</em> - tests for services
<em>xsuaa</em> - authentication via XSUAA
<em>ias</em> - authentication via IAS
<em>ams</em> - authorization via AMS
<em>hana</em> - database support for SAP HANA
<em>postgres</em> - database support for PostgreSQL
<em>sqlite</em> - database support for SQLite
<em>h2</em> - database support for H2
<em>liquibase</em> - database migration using Liquibase
<em>redis</em> - SAP BTP Redis, Hyperscaler Option
<em>h2</em> - database support for H2
<em>multitenancy</em> - schema-based multitenancy support
<em>toggles</em> - allow dynamically toggled features
<em>extensibility</em> - tenant-specific model extensibility
<em>side-by-side-extensibility</em> - logic extensibility via extension points
<em>mtx</em> - multitenancy + toggles + extensibility
<em>attachments</em> - SAP BTP Object Store Service
<em>malware-scanner</em> - SAP Malware Scanning Service
<em>local-messaging</em> - messaging via local event bus
Expand Down Expand Up @@ -191,6 +192,19 @@
Print the generated requests to the console instead of writing them to a file.


<em>cds add test</em>

--filter | -f

Filter for services or entities or actions matching the given pattern. If it contains meta
characters like '^' or '*', it is treated as a regular expression,
otherwise as an include pattern, i.e /.*pattern.*/i

--out | -o

Custom output directory. For Node.js, the default is 'test'.


<em>cds add xsuaa</em>

--plan
Expand All @@ -199,13 +213,15 @@


<strong>EXAMPLES</strong>
<em>cds add</em> sample
<em>cds add</em> multitenancy,hana,xsuaa --for production
<em>cds add</em> data --filter my.namespace.MyEntity
<em>cds add</em> mta
<em>cds add</em> helm

<em>cds add</em> sample
<em>cds add</em> multitenancy,hana,xsuaa
<em>cds add</em> data --filter my.namespace.MyEntity
<em>cds add</em> mta
<em>cds add</em> helm

<strong>SEE ALSO</strong>
<em>cds init</em>

<strong>SUMMARY</strong>
<em>cds add</em> &lt;feature | comma-separated list of features&gt;
</pre>
6 changes: 6 additions & 0 deletions tools/assets/help/cds-debug.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
If &lt;app&gt; is given, it's assumed to be running on the currently logged-in
Cloud Foundry space (check with 'cf target').
SSH access to the app is required (check with 'cf ssh-enabled').
Chrome DevTools are opened automatically for Node.js applications.

If no &lt;app&gt; is given, the app in the current working directory is started
(with 'cds watch --debug' for Node.js and 'mvn spring-boot:run' for Java).
Expand All @@ -25,11 +26,16 @@

the debug port (default: '9229' for Node.js, '8000' for Java)

<em>--no-devtools</em>

don't open developer tools automatically

<em>-f</em> | <em>--force</em>

if necessary, automatically enable ssh for the app and restart it

<strong>EXAMPLES</strong>
<em>cds debug</em>
<em>cds debug</em> bookshop-srv --port 8001
<em>cds debug</em> bookshop-srv --host 0.0.0.0
</pre>
19 changes: 10 additions & 9 deletions tools/assets/help/cds-init.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,29 @@
<em>typer</em> - type generation for CDS models
<em>typescript</em> - add minimum configuration for a bare TypeScript project
<em>extension</em> - Extension project
<em>tiny-sample</em> - add minimal sample files
<em>sample</em> - add sample files including Fiori UI
<em>handler</em> - handler stubs for service entities, actions and functions
<em>mta</em> - Cloud Foundry deployment using mta.yaml
<em>cf-manifest</em> - Cloud Foundry deployment using manifest files
<em>helm</em> - Kyma deployment using Helm charts
<em>helm-unified-runtime</em> - Kyma deployment using Unified Runtime Helm charts
<em>containerize</em> - containerization using ctz CLI
<em>multitenancy</em> - schema-based multitenancy support
<em>toggles</em> - allow dynamically toggled features
<em>extensibility</em> - tenant-specific model extensibility
<em>side-by-side-extensibility</em> - logic extensibility via extension points
<em>mtx</em> - multitenancy + toggles + extensibility
<em>tiny-sample</em> - add minimal sample files
<em>sample</em> - add sample files including Fiori UI
<em>handler</em> - handler stubs for service entities, actions and functions
<em>test</em> - tests for services
<em>xsuaa</em> - authentication via XSUAA
<em>ias</em> - authentication via IAS
<em>ams</em> - authorization via AMS
<em>hana</em> - database support for SAP HANA
<em>postgres</em> - database support for PostgreSQL
<em>sqlite</em> - database support for SQLite
<em>h2</em> - database support for H2
<em>liquibase</em> - database migration using Liquibase
<em>redis</em> - SAP BTP Redis, Hyperscaler Option
<em>h2</em> - database support for H2
<em>multitenancy</em> - schema-based multitenancy support
<em>toggles</em> - allow dynamically toggled features
<em>extensibility</em> - tenant-specific model extensibility
<em>side-by-side-extensibility</em> - logic extensibility via extension points
<em>mtx</em> - multitenancy + toggles + extensibility
<em>attachments</em> - SAP BTP Object Store Service
<em>malware-scanner</em> - SAP Malware Scanning Service
<em>local-messaging</em> - messaging via local event bus
Expand Down
2 changes: 1 addition & 1 deletion tools/assets/help/cds-repl.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<strong>EXAMPLES</strong>
<em>cds repl</em> --run bookshop
<em>cds repl</em> --run .
<em>cds repl</em> --use cds.ql
<em>cds repl</em> --use ql

<strong>SEE ALSO</strong>
<em>cds eval</em> to evaluate and execute JavaScript.
Expand Down
17 changes: 9 additions & 8 deletions tools/assets/help/cds-version-md.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@
| your-project | &lt;Add your repository here&gt; |
| ---------------------- | --------------------------------------- |
| @cap-js/asyncapi | 1.0.3 |
| @cap-js/cds-types | 0.11.0 |
| @cap-js/db-service | 2.1.2 |
| @cap-js/cds-types | 0.12.0 |
| @cap-js/db-service | 2.2.0 |
| @cap-js/openapi | 1.2.3 |
| @cap-js/sqlite | 2.0.1 |
| @sap/cds | 9.0.4 |
| @sap/cds-compiler | 6.0.14 |
| @sap/cds-dk (global) | 9.0.6 |
| @cap-js/sqlite | 2.0.2 |
| @sap/cds | 9.1.0 |
| @sap/cds-compiler | 6.1.0 |
| @sap/cds-dk | 9.1.0 |
| @sap/cds-dk (global) | 9.1.0 |
| @sap/cds-fiori | 2.0.1 |
| @sap/cds-mtxs | 3.0.1 |
| Node.js | v22.16.0 |
| @sap/cds-mtxs | 3.1.0 |
| Node.js | v22.17.0 |
</pre>
17 changes: 9 additions & 8 deletions tools/assets/help/cds-version.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
> cds version

<em>@cap-js/asyncapi</em>: 1.0.3
<em>@cap-js/cds-types</em>: 0.11.0
<em>@cap-js/db-service</em>: 2.1.2
<em>@cap-js/cds-types</em>: 0.12.0
<em>@cap-js/db-service</em>: 2.2.0
<em>@cap-js/openapi</em>: 1.2.3
<em>@cap-js/sqlite</em>: 2.0.1
<em>@sap/cds</em>: 9.0.4
<em>@sap/cds-compiler</em>: 6.0.14
<em>@sap/cds-dk (global)</em>: 9.0.6
<em>@cap-js/sqlite</em>: 2.0.2
<em>@sap/cds</em>: 9.1.0
<em>@sap/cds-compiler</em>: 6.1.0
<em>@sap/cds-dk</em>: 9.1.0
<em>@sap/cds-dk (global)</em>: 9.1.0
<em>@sap/cds-fiori</em>: 2.0.1
<em>@sap/cds-mtxs</em>: 3.0.1
<em>Node.js</em>: v22.16.0
<em>@sap/cds-mtxs</em>: 3.1.0
<em>Node.js</em>: v22.17.0
<em>your-project</em>: 1.0.0
</pre>