Skip to content

Commit e9becf2

Browse files
github-actions[bot]chgeo
github-actions[bot]
and
chgeo
authored
chore: Update CLI texts (#2376)
Updates the output of cds CLI texts to the latest version. Co-authored-by: chgeo <7470719+chgeo@users.noreply.github.com>
1 parent 217a433 commit e9becf2

File tree

9 files changed

+65
-47
lines changed

9 files changed

+65
-47
lines changed

‎tools/assets/help/cds-add.out.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@
7070

7171
Overwrite all files in case the target files already exist.
7272

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

75-
Pull a package from your npm registry.
75+
Pull a package from your configured npm registry.
7676

7777

7878
<strong>FEATURE OPTIONS</strong>

‎tools/assets/help/cds-compile.out.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,5 +126,5 @@
126126
<em>cds</em> compile model.cds
127127
<em>cds</em> c model.json --to sql
128128
<em>cds</em> srv -s all -l all -2 edmx -o out
129-
<em>cds</em> compile srv -s sap.sample.TestService -2 asyncapi -o [0mout
129+
<em>cds</em> compile srv -s sap.sample.TestService -2 asyncapi -o out
130130
</pre>

‎tools/assets/help/cds-debug.out.md‎

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,49 @@
55
<strong>SYNOPSIS</strong>
66
<em>cds debug</em> [&lt;app&gt;]
77

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

12-
If &lt;app&gt; is given, it's assumed to be running on the currently logged-in
13-
Cloud Foundry space (check with 'cf target').
14-
SSH access to the app is required (check with 'cf ssh-enabled').
15-
Chrome DevTools are opened automatically for Node.js applications.
10+
If &lt;app&gt; is given, it's assumed to be running on a remote system. The command defaults
11+
to Kubernetes if Helm deployment descriptors are present, otherwise Cloud Foundry.
12+
13+
For Cloud Foundry, the currently targeted space is used (check with 'cf target').
14+
For Kubernetes, the current context and namespace are used (check with 'kubectl config get-contexts').
15+
16+
SSH access to the app is required (check with 'cf ssh-enabled' on Cloud Foundry).
1617

1718
If no &lt;app&gt; is given, the app in the current working directory is started
1819
(with 'cds watch --debug' for Node.js and 'mvn spring-boot:run' for Java).
1920

21+
For Node.js, Chrome DevTools are opened automatically unless <em>--no-devtools</em> is set.
22+
2023
<strong>OPTIONS</strong>
2124
<em>-h</em> | <em>--host</em>
2225

23-
the debug host (default: '127.0.0.1')
26+
The debug host (default: '127.0.0.1').
2427

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

27-
the debug port (default: '9229' for Node.js, '8000' for Java)
30+
The debug port (default: '9229' for Node.js, '8000' for Java).
31+
32+
<em>--cf</em>
33+
34+
Force Cloud Foundry mode.
35+
36+
<em>--k8s</em>
37+
38+
Force Kubernetes mode. Use env vars KUBE_NAMESPACE or NAMESPACE to select a namespace.
2839

2940
<em>--no-devtools</em>
3041

31-
don't open developer tools automatically
42+
Don't open developer tools automatically (Node.js only).
3243

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

35-
if necessary, automatically enable ssh for the app and restart it
46+
If necessary, automatically enable SSH for the app and restart it.
3647

3748
<strong>EXAMPLES</strong>
3849
<em>cds debug</em>
3950
<em>cds debug</em> bookshop-srv --port 8001
4051
<em>cds debug</em> bookshop-srv --host 0.0.0.0
52+
<em>cds debug</em> --k8s bookshop-srv
4153
</pre>

‎tools/assets/help/cds-env-ls-requires-db.out.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
<pre class="log">
33
> cds env ls requires.db
44

5-
requires.db.credentials.url = :memory:
6-
requires.db.impl = @cap-js/sqlite
7-
requires.db.kind = sqlite
5+
requires.db.credentials.url = <em>':memory:'</em>
6+
requires.db.data = [ <em>'db/data'</em>, <em>'db/csv'</em>, <em>'test/data'</em> ]
7+
requires.db.impl = <em>'@cap-js/sqlite'</em>
8+
requires.db.kind = <em>'sqlite'</em>
89
requires.db.pool.max = <em>1</em>
910
</pre>

‎tools/assets/help/cds-env-requires-db.out.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,10 @@
33
> cds env requires.db
44

55
{
6-
"impl": "@cap-js/sqlite",
7-
"credentials": {
8-
"url": ":memory:"
9-
},
10-
"pool": {
11-
"max": 1
12-
},
13-
"kind": "sqlite"
6+
impl: <em>'@cap-js/sqlite'</em>,
7+
credentials: { url: <em>':memory:'</em> },
8+
data: [ <em>'db/data'</em>, <em>'db/csv'</em>, <em>'test/data'</em> ],
9+
pool: { max: <em>1</em> },
10+
kind: <em>'sqlite'</em>
1411
}
1512
</pre>

‎tools/assets/help/cds-eval-env-requires-db.out.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
{
66
impl: <em>'@cap-js/sqlite'</em>,
77
credentials: { url: <em>':memory:'</em> },
8+
data: [ <em>'db/data'</em>, <em>'db/csv'</em>, <em>'test/data'</em> ],
89
pool: { max: <em>1</em> },
910
kind: <em>'sqlite'</em>
1011
}

‎tools/assets/help/cds-init.out.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@
6868
<em>github-actions</em> - CI/CD pipeline via GitHub Actions
6969
<em>console</em> - installs the CAP console plugin
7070

71+
<em>--nodejs</em>
72+
73+
Create a CAP Node.js project.
74+
7175
<em>--java</em>
7276

7377
Create a CAP Java project.
@@ -84,6 +88,7 @@
8488

8589
<strong>EXAMPLES</strong>
8690
<em>cds init</em> bookshop
91+
<em>cds init</em> bookshop --nodejs
8792
<em>cds init</em> bookshop --java
8893
<em>cds init</em> bookshop --add hana
8994
<em>cds init</em> bookshop --add multitenancy,mta

‎tools/assets/help/cds-version-md.out.md‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,17 @@
22
<pre class="log">
33
> cds version --markdown
44

5-
| your-project | https://github.com/&lt;your/repo&gt; |
6-
| ---------------------- | --------------------------------------- |
7-
| @sap/cds | 9.6.4 |
8-
| @sap/cds-compiler | 6.6.2 |
9-
| @sap/cds-dk (global) | 9.6.1 |
10-
| @sap/cds-fiori | 2.1.1 |
11-
| @sap/cds-mtxs | 3.6.1 |
12-
| @cap-js/asyncapi | 1.0.3 |
13-
| @cap-js/db-service | 2.8.1 |
14-
| @cap-js/openapi | 1.3.1 |
15-
| @cap-js/sqlite | 2.1.2 |
16-
| Node.js | v22.22.0 |
5+
| Package | Version | Location |
6+
| -------------------- | ------- | ------------------------------------------------------------------ |
7+
|<em> @sap/cds-dk (global) </em>|<em> 9.7.1 </em>|<i> .../node_modules/@sap/cds-dk </i>|
8+
|<em> @sap/cds </em>|<em> 9.7.1 </em>|<i> .../node_modules/@sap/cds </i>|
9+
|<em> @sap/cds-compiler </em>|<em> 6.7.2 </em>|<i> .../node_modules/@sap/cds-compiler </i>|
10+
|<em> @sap/cds-fiori </em>|<em> 2.2.0 </em>|<i> .../node_modules/@sap/cds-fiori </i>|
11+
|<em> @cap-js/db-service </em>|<em> 2.8.2 </em>|<i> .../node_modules/@cap-js/db-service </i>|
12+
|<em> @cap-js/sqlite </em>|<em> 2.1.3 </em>|<i> .../node_modules/@cap-js/sqlite </i>|
13+
|<em> cds.home </em>|<em> </em>|<i> .../node_modules/@sap/cds </i>|
14+
|<em> cds.root </em>|<em> </em>|<i> .../your-project </i>|
15+
|<em> npm root -l </em>|<em> </em>|<i> .../node_modules </i>|
16+
|<em> npm root -g </em>|<em> </em>|<i> .../node_modules </i>|
17+
|<em> Node.js </em>|<em> 24.13.0 </em>|<i> .../bin/node </i>|
1718
</pre>

‎tools/assets/help/cds-version.out.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
<pre class="log">
33
> cds version
44

5-
@sap/cds: 9.6.4
6-
@sap/cds-compiler: 6.6.2
7-
@sap/cds-dk (global): 9.6.1
8-
@sap/cds-fiori: 2.1.1
9-
@sap/cds-mtxs: 3.6.1
10-
@cap-js/asyncapi: 1.0.3
11-
@cap-js/db-service: 2.8.1
12-
@cap-js/openapi: 1.3.1
13-
@cap-js/sqlite: 2.1.2
14-
Node.js: v22.22.0
5+
<em> @sap/cds-dk (global) </em><em> 9.7.1 </em><i> .../node_modules/@sap/cds-dk </i>
6+
<em> @sap/cds </em><em> 9.7.1 </em><i> .../node_modules/@sap/cds </i>
7+
<em> @sap/cds-compiler </em><em> 6.7.2 </em><i> .../node_modules/@sap/cds-compiler </i>
8+
<em> @sap/cds-fiori </em><em> 2.2.0 </em><i> .../node_modules/@sap/cds-fiori </i>
9+
<em> @cap-js/db-service </em><em> 2.8.2 </em><i> .../node_modules/@cap-js/db-service </i>
10+
<em> @cap-js/sqlite </em><em> 2.1.3 </em><i> .../node_modules/@cap-js/sqlite </i>
11+
<em> cds.home </em><em> </em><i> .../node_modules/@sap/cds </i>
12+
<em> cds.root </em><em> </em><i> .../your-project </i>
13+
<em> npm root -l </em><em> </em><i> .../node_modules </i>
14+
<em> npm root -g </em><em> </em><i> .../node_modules </i>
15+
<em> Node.js </em><em> 24.13.0 </em><i> .../bin/node </i>
1516
</pre>

0 commit comments

Comments
 (0)