⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

chore: Update CLI texts #2376

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 1 commit into from
Feb 10, 2026
Merged

chore: Update CLI texts #2376

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
4 changes: 2 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 @@ -70,9 +70,9 @@

Overwrite all files in case the target files already exist.

<em>--package</em> &lt;name&gt;
<em>--package | -p</em> &lt;name&gt;

Pull a package from your npm registry.
Pull a package from your configured npm registry.


<strong>FEATURE OPTIONS</strong>
Expand Down
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 @@ -126,5 +126,5 @@
<em>cds</em> compile model.cds
<em>cds</em> c model.json --to sql
<em>cds</em> srv -s all -l all -2 edmx -o out
<em>cds</em> compile srv -s sap.sample.TestService -2 asyncapi -o [0mout
<em>cds</em> compile srv -s sap.sample.TestService -2 asyncapi -o out
</pre>
34 changes: 23 additions & 11 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 @@ -5,37 +5,49 @@
<strong>SYNOPSIS</strong>
<em>cds debug</em> [&lt;app&gt;]

Debug applications running locally or remotely on Cloud Foundry.
Local applications will be started in debug mode, while remote applications
are put into debug mode.
Debug applications running locally or remotely on Cloud Foundry or Kubernetes.

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 &lt;app&gt; is given, it's assumed to be running on a remote system. The command defaults
to Kubernetes if Helm deployment descriptors are present, otherwise Cloud Foundry.

For Cloud Foundry, the currently targeted space is used (check with 'cf target').
For Kubernetes, the current context and namespace are used (check with 'kubectl config get-contexts').

SSH access to the app is required (check with 'cf ssh-enabled' on Cloud Foundry).

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).

For Node.js, Chrome DevTools are opened automatically unless <em>--no-devtools</em> is set.

<strong>OPTIONS</strong>
<em>-h</em> | <em>--host</em>

the debug host (default: '127.0.0.1')
The debug host (default: '127.0.0.1').

<em>-p</em> | <em>--port</em>

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

<em>--cf</em>

Force Cloud Foundry mode.

<em>--k8s</em>

Force Kubernetes mode. Use env vars KUBE_NAMESPACE or NAMESPACE to select a namespace.

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

don't open developer tools automatically
Don't open developer tools automatically (Node.js only).

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

if necessary, automatically enable ssh for the app and restart it
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
<em>cds debug</em> --k8s bookshop-srv
</pre>
7 changes: 4 additions & 3 deletions tools/assets/help/cds-env-ls-requires-db.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
<pre class="log">
> cds env ls requires.db

requires.db.credentials.url = :memory:
requires.db.impl = @cap-js/sqlite
requires.db.kind = sqlite
requires.db.credentials.url = <em>':memory:'</em>
requires.db.data = [ <em>'db/data'</em>, <em>'db/csv'</em>, <em>'test/data'</em> ]
requires.db.impl = <em>'@cap-js/sqlite'</em>
requires.db.kind = <em>'sqlite'</em>
requires.db.pool.max = <em>1</em>
</pre>
13 changes: 5 additions & 8 deletions tools/assets/help/cds-env-requires-db.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,10 @@
> cds env requires.db

{
"impl": "@cap-js/sqlite",
"credentials": {
"url": ":memory:"
},
"pool": {
"max": 1
},
"kind": "sqlite"
impl: <em>'@cap-js/sqlite'</em>,
credentials: { url: <em>':memory:'</em> },
data: [ <em>'db/data'</em>, <em>'db/csv'</em>, <em>'test/data'</em> ],
pool: { max: <em>1</em> },
kind: <em>'sqlite'</em>
}
</pre>
1 change: 1 addition & 0 deletions tools/assets/help/cds-eval-env-requires-db.out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
{
impl: <em>'@cap-js/sqlite'</em>,
credentials: { url: <em>':memory:'</em> },
data: [ <em>'db/data'</em>, <em>'db/csv'</em>, <em>'test/data'</em> ],
pool: { max: <em>1</em> },
kind: <em>'sqlite'</em>
}
Expand Down
5 changes: 5 additions & 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 @@ -68,6 +68,10 @@
<em>github-actions</em> - CI/CD pipeline via GitHub Actions
<em>console</em> - installs the CAP console plugin

<em>--nodejs</em>

Create a CAP Node.js project.

<em>--java</em>

Create a CAP Java project.
Expand All @@ -84,6 +88,7 @@

<strong>EXAMPLES</strong>
<em>cds init</em> bookshop
<em>cds init</em> bookshop --nodejs
<em>cds init</em> bookshop --java
<em>cds init</em> bookshop --add hana
<em>cds init</em> bookshop --add multitenancy,mta
Expand Down
25 changes: 13 additions & 12 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 @@ -2,16 +2,17 @@
<pre class="log">
> cds version --markdown

| your-project | https://github.com/&lt;your/repo&gt; |
| ---------------------- | --------------------------------------- |
| @sap/cds | 9.6.4 |
| @sap/cds-compiler | 6.6.2 |
| @sap/cds-dk (global) | 9.6.1 |
| @sap/cds-fiori | 2.1.1 |
| @sap/cds-mtxs | 3.6.1 |
| @cap-js/asyncapi | 1.0.3 |
| @cap-js/db-service | 2.8.1 |
| @cap-js/openapi | 1.3.1 |
| @cap-js/sqlite | 2.1.2 |
| Node.js | v22.22.0 |
| Package | Version | Location |
| -------------------- | ------- | ------------------------------------------------------------------ |
|<em> @sap/cds-dk (global) </em>|<em> 9.7.1 </em>|<i> .../node_modules/@sap/cds-dk </i>|
|<em> @sap/cds </em>|<em> 9.7.1 </em>|<i> .../node_modules/@sap/cds </i>|
|<em> @sap/cds-compiler </em>|<em> 6.7.2 </em>|<i> .../node_modules/@sap/cds-compiler </i>|
|<em> @sap/cds-fiori </em>|<em> 2.2.0 </em>|<i> .../node_modules/@sap/cds-fiori </i>|
|<em> @cap-js/db-service </em>|<em> 2.8.2 </em>|<i> .../node_modules/@cap-js/db-service </i>|
|<em> @cap-js/sqlite </em>|<em> 2.1.3 </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.13.0 </em>|<i> .../bin/node </i>|
</pre>
21 changes: 11 additions & 10 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,14 +2,15 @@
<pre class="log">
> cds version

@sap/cds: 9.6.4
@sap/cds-compiler: 6.6.2
@sap/cds-dk (global): 9.6.1
@sap/cds-fiori: 2.1.1
@sap/cds-mtxs: 3.6.1
@cap-js/asyncapi: 1.0.3
@cap-js/db-service: 2.8.1
@cap-js/openapi: 1.3.1
@cap-js/sqlite: 2.1.2
Node.js: v22.22.0
<em> @sap/cds-dk (global) </em><em> 9.7.1 </em><i> .../node_modules/@sap/cds-dk </i>
<em> @sap/cds </em><em> 9.7.1 </em><i> .../node_modules/@sap/cds </i>
<em> @sap/cds-compiler </em><em> 6.7.2 </em><i> .../node_modules/@sap/cds-compiler </i>
<em> @sap/cds-fiori </em><em> 2.2.0 </em><i> .../node_modules/@sap/cds-fiori </i>
<em> @cap-js/db-service </em><em> 2.8.2 </em><i> .../node_modules/@cap-js/db-service </i>
<em> @cap-js/sqlite </em><em> 2.1.3 </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.13.0 </em><i> .../bin/node </i>
</pre>