The diagnostics command generates a diagnostic bundle containing logs, configuration, and system information. This is useful when troubleshooting issues or submitting support requests.

Usage

hooklistener diagnostics [OPTIONS]

Options

Option	Description
`--output <PATH>`	Custom output path for the diagnostic bundle
`--include-logs`	Include full log files (default: last 1000 lines)
`--help`	Show help information

What's Included

The diagnostic bundle is a ZIP file containing:

•
System information: OS version, CPU architecture, available memory
•
CLI version: The exact version of the Hooklistener CLI
•
Configuration: Your CLI config (with sensitive tokens redacted)
•
Recent logs: The last 1000 lines of log files (or full logs with --include-logs)
•
Network info: Basic connectivity test results

Privacy:Authentication tokens and sensitive data are automatically redacted from the bundle. Review the contents before sharing if you have concerns.

Examples

Generate Diagnostic Bundle

Create a bundle in the current directory:

hooklistener diagnostics

Output:

Collecting system information...
Collecting CLI configuration...
Collecting recent logs...
Running connectivity tests...

✓ Diagnostic bundle created: hooklistener-diagnostics-2026-01-14.zip

Please attach this file when contacting support.

Custom Output Path

Save the bundle to a specific location:

hooklistener diagnostics --output ~/Desktop/debug.zip

Include Full Logs

Include complete log history for deep debugging:

hooklistener diagnostics --include-logs

When to Use

Generate a diagnostic bundle when you experience:

Connection issues or frequent disconnects
Unexpected errors or crashes
Performance problems
Authentication failures
Any issue you can't resolve yourself

Support:When contacting support, always include the diagnostic bundle. It helps us identify and resolve issues much faster.

clean-logs — Remove old log files to free up disk space
CLI Getting Started — Configuration file locations and logging options

diagnostics Command