Skip to content

Commit 45aacfd

Browse files
committed
doc
1 parent 40dd83b commit 45aacfd

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

website/docs/CLI/cts-commands.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@ apic cts generate <language | all> <client... | all>
2626

2727
### Available options
2828

29-
| Option | Command | Description |
30-
| ------- | :------------ | :------------------------------------------------------------ |
31-
| verbose | -v, --verbose | Make the process verbose, display logs from third party tools |
29+
| Option | Command | Description |
30+
|----------|:---------------|:----------------------------------------------------------------------------------|
31+
| verbose | -v, --verbose | Make the process verbose, display logs from third party tools |
32+
| debugger | -d, --debugger | runs the generator in debug mode, it will wait for a Java debugger to be attached |
3233

3334
## Generate
3435

@@ -50,6 +51,32 @@ apic cts generate java search
5051
apic cts generate php insights recommend search
5152
```
5253

54+
### Attach a debugger to the generator
55+
56+
Using VS code extension [Debugger For Java](https://code.visualstudio.com/docs/java/java-debugging), you can attach breakpoint to the generator.
57+
Example config for VS Code in `.vscode/launch.json`:
58+
59+
```json
60+
{
61+
"version": "0.2.0",
62+
"configurations": [
63+
{
64+
"type": "java",
65+
"name": "APIC Generator",
66+
"request": "attach",
67+
"hostName": "localhost",
68+
"port": "5009"
69+
}
70+
]
71+
}
72+
```
73+
74+
```bash
75+
apic cts generate java search -d
76+
```
77+
78+
Then you can connect you favorite Java debugger, either IntelliJ, VS Code, or jdb.
79+
5380
## Run
5481

5582
### Run CTS for all supported languages

0 commit comments

Comments
 (0)