Skip to content

Commit ee31029

Browse files
committed
Improve help section
1 parent 8ff09a8 commit ee31029

File tree

1 file changed

+14
-17
lines changed
  • packages/php-wasm/xdebug-bridge/src

1 file changed

+14
-17
lines changed

packages/php-wasm/xdebug-bridge/src/cli.ts

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,41 +13,38 @@ interface CLIArgs {
1313

1414
function parseCliArgs(): CLIArgs {
1515
return yargs(hideBin(process.argv))
16+
.usage(
17+
`
18+
XDebug Bridge Server CLI
19+
20+
Usage: xdebug-bridge [options]
21+
`
22+
)
1623
.option('port', {
1724
alias: 'p',
1825
type: 'number',
19-
description: 'Port to listen on',
26+
description: 'Xdebug port to listen on',
2027
default: 9003,
2128
})
2229
.option('host', {
2330
alias: 'h',
2431
type: 'string',
25-
description: 'Host to bind to',
32+
description: 'Xdebug host to bind to',
2633
default: 'localhost',
2734
})
2835
.option('php-root', {
2936
type: 'string',
30-
description: 'Path to PHP root directory for file resolution',
37+
description: 'Path to PHP root directory',
3138
default: './',
3239
})
33-
.option('verbose', {
34-
alias: 'v',
35-
type: 'boolean',
36-
description: 'Enable verbose logging',
37-
default: false,
38-
})
3940
.help()
40-
.usage(
41+
.epilog(
4142
`
42-
XDebug Bridge Server CLI
43-
44-
Usage: xdebug-bridge [options]
45-
4643
Examples:
4744
xdebug-bridge # Start with default settings
48-
xdebug-bridge --port 9000 --verbose # Custom port with verbose logging
49-
xdebug-bridge --php-root /path/to/php/files # Specify PHP root directory
50-
`
45+
xdebug-bridge --port 9000 --verbose # Custom port with verbose logging
46+
xdebug-bridge --php-root /path/to/php/files # Specify PHP root directory
47+
`
5148
)
5249
.parseSync() as CLIArgs;
5350
}

0 commit comments

Comments
 (0)