Skip to content

v0.1.11 - CLI Command Naming Improvements (2025-12-03)

What Changed?

This release improves CLI usability by renaming commands for better discoverability and consistency. The listen command is renamed to read for streaming detection events, and the send command is renamed to query for sending commands to the device. These shorter, more intuitive names reduce typing effort and align with common command naming conventions.

What's New

Renamed CLI Commands

What it does:

Two core CLI commands have been renamed to improve usability and typing efficiency:

  • listen → read: Stream detection events from the device
  • send → query: Send commands to the device and get responses

How to use it:

# Read detection events
uv run kazunoko read --count 100

# Query the device
uv run kazunoko query STATUS
uv run kazunoko query "SET_POLL_COUNT 200"

All other commands (version, threshold, info, generate) remain unchanged.

Installation

Quick Start

# Get the release
git checkout vX.Y.Z

# Setup
task env:setup

# Run CLI
uv run kazunoko --help

What's Different from the Last Version?

✅ Added

  • CLI documentation section for query command in getting-started guide
  • Release notes file for v0.1.11

🔧 Changed

  • Renamed listen command to read for better usability
  • Renamed send command to query for consistency
  • Updated CLI documentation to reflect new command names
  • Updated homepage examples with new command names

🐛 Fixed

  • None

Is It Safe to Upgrade?

Backward Compatible: No (CLI commands renamed)

  • Users will need to update their CLI scripts and commands that use listen → read or send → query
  • All other functionality remains unchanged
  • Python API (device.query()) is unaffected

Tests Passed

  • ✅ Builds without errors
  • ✅ CLI commands registered and callable
  • ✅ Documentation updated and formatted correctly

Release Details

  • Date: 2025-12-03
  • Version: v0.1.11
  • Files Changed: 5 (cli.py, cli.md, index.md, v0.1.11.md)
  • Commits: 368b98a, ab59cd8

Next Steps

  • Consider adding aliases for deprecated command names if needed
  • Gather user feedback on the new command names
  • Plan additional CLI enhancements based on user preferences