CLI Reference
The ocpp-debugkit CLI provides commands for inspecting traces, generating reports, and running scenarios.
Installation
npm install -g @ocpp-debugkit/cliinspect
Parse and analyze an OCPP trace file. Outputs a summary with events, sessions, failures, and warnings.
ocpp-debugkit inspect <file>Example:
ocpp-debugkit inspect trace.jsonreport
Generate a Markdown report from an OCPP trace file.
ocpp-debugkit report <file> [options]Options
-f, --format <format>— Report format (default: markdown)-o, --output <file>— Write report to file (default: stdout)
Example:
ocpp-debugkit report trace.json --output report.mdscenario list
List all available built-in scenarios.
ocpp-debugkit scenario listscenario run
Run a built-in scenario through the analysis engine. Compares detected failures against expected failures and reports pass/fail.
ocpp-debugkit scenario run <name>Example:
ocpp-debugkit scenario run failed-authNote: scenario run runs static fixtures through the local analysis engine only. It is not active endpoint testing, WebSocket simulation, or live station/CSMS testing.
Global Options
-V, --version— output the version number-h, --help— display help for any command
Security
- File paths are validated before reading
- Input size limit: 10 MB
- Safe JSON parsing with error handling
- Non-sensitive error messages (no internal paths exposed)