Skip to content

chore: Update CLI texts #2868

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
renejeglinsky merged 1 commit into from
Sep 9, 2026
Merged

chore: Update CLI texts #2868

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
23 changes: 21 additions & 2 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 @@ -3,7 +3,7 @@
> cds add --help

<strong>SYNOPSIS</strong>
<em>cds add</em> &lt;feature | comma-separated list of features&gt;
<em>cds add</em> &lt;feature&gt; [&lt;feature&gt; ...]

Add one or more features to an existing project - grow as you go.

Expand All @@ -27,6 +27,7 @@
<em>ias</em> - authentication via IAS
<em>ams</em> - authorization via AMS
<em>hana</em> - database support for SAP HANA
<em>hana-serverless</em> - database support for SAP HANA Cloud serverless
<em>postgres</em> - database support for PostgreSQL
<em>sqlite</em> - database support for SQLite
<em>liquibase</em> - database migration using Liquibase
Expand Down Expand Up @@ -83,6 +84,13 @@


<strong>FEATURE OPTIONS</strong>
<em>cds add ai</em>

--plan

Specify the service plan.


<em>cds add audit-logging</em>

--plan
Expand Down Expand Up @@ -126,6 +134,10 @@

The number of records to be created for each entity.

--composition-records

The number of records to be created per to-many composition (default 2).

--content-type | -c

The content type of the data. One of "json" or "csv".
Expand All @@ -134,6 +146,12 @@

The output target folder.

--keys-only

Only fill key values into the generated CSV records, leaving all
other columns empty. Requires '--records'. Useful to generate placeholder
rows for an agent or human to fill in later.


<em>cds add enterprise-messaging</em>

Expand Down Expand Up @@ -251,6 +269,7 @@

<strong>EXAMPLES</strong>
<em>cds add</em> sample
<em>cds add</em> multitenancy hana xsuaa
<em>cds add</em> multitenancy,hana,xsuaa
<em>cds add</em> data --filter my.namespace.MyEntity
<em>cds add</em> mta
Expand All @@ -260,5 +279,5 @@
<em>cds init</em>

<strong>SUMMARY</strong>
<em>cds add</em> &lt;feature | comma-separated list of features&gt;
<em>cds add</em> &lt;feature&gt; [&lt;feature&gt; ...]
</pre>
2 changes: 1 addition & 1 deletion tools/assets/help/cds-compile.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
- cdl
- xsuaa
- openapi
- asyncapi
- asyncapi (requires @cap-js/asyncapi as a project dependency, currently bundled as a fallback)

<em>-4</em> | <em>--for</em> &lt;target&gt;

Expand Down
1 change: 1 addition & 0 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 @@ -32,6 +32,7 @@
<em>ias</em> - authentication via IAS
<em>ams</em> - authorization via AMS
<em>hana</em> - database support for SAP HANA
<em>hana-serverless</em> - database support for SAP HANA Cloud serverless
<em>postgres</em> - database support for PostgreSQL
<em>sqlite</em> - database support for SQLite
<em>liquibase</em> - database migration using Liquibase
Expand Down
13 changes: 7 additions & 6 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 @@ -4,15 +4,16 @@

| Package | Version | Location |
| -------------------- | ------- | ------------------------------------------------------------------ |
|<em> @sap/cds-dk (global) </em>|<em> 10.0.7 </em>|<i> .../node_modules/@sap/cds-dk </i>|
|<em> @sap/cds </em>|<em> 10.0.6 </em>|<i> .../node_modules/@sap/cds </i>|
|<em> @sap/cds-compiler </em>|<em> 7.0.3 </em>|<i> .../node_modules/@sap/cds-compiler </i>|
|<em> @sap/cds-dk (global) </em>|<em> 10.1.0 </em>|<i> .../node_modules/@sap/cds-dk </i>|
|<em> @sap/cds </em>|<em> 10.1.0 </em>|<i> .../node_modules/@sap/cds </i>|
|<em> @sap/cds-compiler </em>|<em> 7.1.0 </em>|<i> .../node_modules/@sap/cds-compiler </i>|
|<em> @sap/cds-fiori </em>|<em> 2.3.0 </em>|<i> .../node_modules/@sap/cds-fiori </i>|
|<em> @cap-js/db-service </em>|<em> 3.0.1 </em>|<i> .../node_modules/@cap-js/db-service </i>|
|<em> @cap-js/sqlite </em>|<em> 3.0.2 </em>|<i> .../node_modules/@cap-js/sqlite </i>|
|<em> @cap-js/db-service </em>|<em> 3.1.0 </em>|<i> .../node_modules/@cap-js/db-service </i>|
|<em> @cap-js/sqlite </em>|<em> 3.1.0 </em>|<i> .../node_modules/@cap-js/sqlite </i>|
|<em> cds.home </em>|<em> </em>|<i> .../node_modules/@sap/cds </i>|
|<em> cds.root </em>|<em> </em>|<i> .../your-project </i>|
|<em> npm root -l </em>|<em> </em>|<i> .../node_modules </i>|
|<em> npm root -g </em>|<em> </em>|<i> .../node_modules </i>|
|<em> Node.js </em>|<em> 24.19.0 </em>|<i> .../bin/node </i>|
|<em> Node.js </em>|<em> 24.20.0 </em>|<i> .../bin/node </i>|
|<em> npm </em>|<em> 11.19.0 </em>|<i> /opt/hostedtoolcache/node/24.20.0/x64/bin/npm </i>|
</pre>
13 changes: 7 additions & 6 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 @@ -2,15 +2,16 @@
<pre class="log">
> cds version

<em> @sap/cds-dk (global) </em><em> 10.0.7 </em><i> .../node_modules/@sap/cds-dk </i>
<em> @sap/cds </em><em> 10.0.6 </em><i> .../node_modules/@sap/cds </i>
<em> @sap/cds-compiler </em><em> 7.0.3 </em><i> .../node_modules/@sap/cds-compiler </i>
<em> @sap/cds-dk (global) </em><em> 10.1.0 </em><i> .../node_modules/@sap/cds-dk </i>
<em> @sap/cds </em><em> 10.1.0 </em><i> .../node_modules/@sap/cds </i>
<em> @sap/cds-compiler </em><em> 7.1.0 </em><i> .../node_modules/@sap/cds-compiler </i>
<em> @sap/cds-fiori </em><em> 2.3.0 </em><i> .../node_modules/@sap/cds-fiori </i>
<em> @cap-js/db-service </em><em> 3.0.1 </em><i> .../node_modules/@cap-js/db-service </i>
<em> @cap-js/sqlite </em><em> 3.0.2 </em><i> .../node_modules/@cap-js/sqlite </i>
<em> @cap-js/db-service </em><em> 3.1.0 </em><i> .../node_modules/@cap-js/db-service </i>
<em> @cap-js/sqlite </em><em> 3.1.0 </em><i> .../node_modules/@cap-js/sqlite </i>
<em> cds.home </em><em> </em><i> .../node_modules/@sap/cds </i>
<em> cds.root </em><em> </em><i> .../your-project </i>
<em> npm root -l </em><em> </em><i> .../node_modules </i>
<em> npm root -g </em><em> </em><i> .../node_modules </i>
<em> Node.js </em><em> 24.19.0 </em><i> .../bin/node </i>
<em> Node.js </em><em> 24.20.0 </em><i> .../bin/node </i>
<em> npm </em><em> 11.19.0 </em><i> /opt/hostedtoolcache/node/24.20.0/x64/bin/npm </i>
</pre>