Skip to content

kazunoko status

Display comprehensive diagnostic information about the library environment and connected detector.

Basic Usage

kazunoko status

What This Command Shows

Category Fields
Library kazunoko version, dependency versions (pydantic, pyserial, typer, loguru)
Python Python version, executable path, virtual environment type
Platform OS, release, architecture, Python implementation
Device Connected port, firmware version, MAC address, status, uptime

Device information is only collected when a detector is connected. Use --mock to check library and environment information without hardware.

CLI Options

Option Short Default Description
--port -p auto Serial port, or auto for auto-detection
--timeout -t 0.1 Serial communication timeout in seconds
--verbose / --quiet -v / -q --quiet Show or suppress status messages
--format -f jsonl Output format: jsonl, table, json, csv, ssv, tsv, ltsv
--use-flat / --use-raw --use-flat Use flattened or raw field names
--mock off Collect environment info without connecting to a device

Usage Examples

Display as a table

kazunoko status --format table

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Field                          ┃ Value                      ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ library_kazunoko_version       │ 0.20.0                     │
│ python_python_version          │ 3.12.7                     │
│ python_venv_type               │ uv                         │
│ platform_os_system             │ Darwin                     │
│ platform_architecture          │ arm64                      │
│ device_connected_port          │ /dev/ttyUSB0               │
│ device_firmware_version        │ 1.19.3                     │
│ device_mac_address             │ 30:AE:A4:9D:08:2C          │
│ device_uptime_ms               │ 674643                     │
└────────────────────────────────┴────────────────────────────┘

Check environment without hardware

kazunoko status --mock

Extract a specific field with jq

kazunoko status --format json | jq .library_kazunoko_version

Specify serial port

kazunoko status --port /dev/ttyUSB0