diff --git a/docs/src/cli/index.md b/docs/src/cli/index.md index 4afa036c4..1074e373a 100644 --- a/docs/src/cli/index.md +++ b/docs/src/cli/index.md @@ -22,4 +22,26 @@ Commands: version Prints zombienet version help [command] display help for command +Debug: + The debug/verbose output is managed by the DEBUG environment variable, you can enable/disable specific debugging namespaces setting an space or comma-delimited names. + $ e.g $ DEBUG=zombie, zombie::paras zombienet spawn example/0001-example.toml + + The available namespaces are: + zombie + zombie::chain + zombie::cmdGenerator + zombie::config + zombie::helper + zombie::js + zombie::kube + zombie::metrics + zombie::native + zombie::network + zombie::paras + zombie::podman + zombie::spawner + zombie::substrateCliArgsVersion + zombie::test + + NOTE: wildcard (e.g.'zombie*') are supported, for advance use check https://www.npmjs.com/package/debug#wildcards ``` diff --git a/javascript/packages/cli/src/cli.ts b/javascript/packages/cli/src/cli.ts index 75c8e38cb..f33c35e4e 100644 --- a/javascript/packages/cli/src/cli.ts +++ b/javascript/packages/cli/src/cli.ts @@ -159,6 +159,35 @@ program process.exit(0); }); +program.addHelpText( + "after", + ` + +Debug: + The debug/verbose output is managed by the DEBUG environment variable, you can enable/disable specific debugging namespaces setting an space or comma-delimited names. + $ e.g $ DEBUG=zombie, zombie::paras zombienet spawn example/0001-example.toml + + The available namespaces are: + zombie + zombie::chain + zombie::cmdGenerator + zombie::config + zombie::helper + zombie::js + zombie::kube + zombie::metrics + zombie::native + zombie::network + zombie::paras + zombie::podman + zombie::spawner + zombie::substrateCliArgsVersion + zombie::test + + NOTE: wildcard (e.g.'zombie*') are supported, for advance use check https://www.npmjs.com/package/debug#wildcards +`, +); + program.parse(process.argv); function asyncAction(cmd: Function) {