Skip to main content

bb-eco diagnostics

Collect system and network diagnostic information

Usage

bb-eco diagnostics [options]

Options

OptionDescription
--csvOutput in CSV format
--discoverRun a quick discovery scan (3 seconds) and include results
--jsonOutput in JSON format
--output <output>Write diagnostics to a file instead of stdout
--timeout <timeout>Override default timeout in milliseconds
--verboseEnable verbose/debug output
-?, -h, --helpShow help and usage information

Examples

Write a JSON snapshot of the operating system, CPU architecture and every network interface (address, subnet, multicast support) for a support ticket:

bb-eco diagnostics --output bb-eco-diagnostics.json
Diagnostics written to bb-eco-diagnostics.json

Include a fresh three-second discovery sweep so support can see which Brainboxes devices are visible from your machine:

bb-eco diagnostics --output bb-eco-diagnostics.json --discover

Attach the file to your email to [email protected]. It does not include log files; if support asks for those, attach them from the log directory (~/Library/Logs/bb-eco/ on macOS, ~/.config/bb-eco/logs/ on Linux, %APPDATA%\bb-eco\logs\ on Windows). Passwords, tokens and other credentials are masked before the logs are written; the log files still contain device IP addresses, MAC addresses and device names, so review them before sharing outside your organisation.

Both are separate from the optional anonymous firmware-update diagnostics (bb-eco telemetry), which never include addresses or names.

This page is auto-generated from the live CLI help text. Do not edit by hand - re-run node scripts/gen-cli-reference.mjs after changes. Example sections are maintained in docs/cli-examples/ in the bb-eco repo.