Skip to content

v0.1.15 - CLI Command Naming Consistency (2025-12-05)

What Changed?

This release improves CLI command naming consistency by renaming the info command to status. The read command has also been updated to use cmd.rtc_time() instead of the deprecated cmd.time(). These changes align CLI command names with the underlying Python method names they invoke, reducing confusion and improving discoverability.

What's New

Main Feature: CLI Command Naming Consistency

What it does: The CLI command info has been renamed to status to match the underlying Command.status() method it invokes. This makes the CLI more discoverable and consistent with the device command naming scheme. The read command now uses the renamed rtc_time() method for setting device time.

How to use it: Simply use the status command instead of info to display device configuration:

# Display device status in table format
kazunoko status

# Specify port
kazunoko status --port /dev/ttyUSB0

# Verbose output
kazunoko status -v

Code example:

# Python API (no changes - rtc_time() was already updated in v0.1.14)
from kazunoko import connect, Command

with connect() as device:
    cmd = Command(device)

    # Get device status
    resp = cmd.status()
    print(resp.version)

    # Get or set RTC time
    resp = cmd.rtc_time()  # Get current time
    resp = cmd.rtc_time(1234567890)  # Set time

Installation

Quick Start

# Get the release
git checkout v0.1.15

# Setup
uv sync

# Run CLI
uv run kazunoko --help

What's Different from the Last Version?

✅ Added

  • CLI command naming documentation in README and CLAUDE.md

🔧 Changed

  • CLI info command renamed to status for consistency with Command.status() method
  • read command now uses cmd.rtc_time() instead of deprecated cmd.time()
  • Updated all documentation examples to use kazunoko status
  • Updated CLAUDE.md CLI section to reflect new command name

🐛 Fixed

  • CLI command naming inconsistency where info command didn't match method name status()

Is It Safe to Upgrade?

Backward Compatible: No (CLI only)

  • The Python API remains completely unchanged
  • Only the CLI command name has changed: kazunoko info → kazunoko status
  • All Python code using the Command class will continue to work without modifications
  • Scripts that call kazunoko info will need to be updated to use kazunoko status

Tests Passed

  • ✅ Builds without errors (uv build)
  • ✅ Linting passes (ruff check src/)
  • ✅ Code formatting verified (ruff format src/)
  • ✅ Pre-commit hooks pass (commitizen conventional commits)

Release Details

  • Date: 2025-12-05
  • Version: v0.1.15
  • Files Changed: 3 (cli.py, README.md, CLAUDE.md)
  • Commits:
  • 9c694f5 refactor: rename CLI info command to status and update rtc_time call
  • bc9f338 docs: update README to use 'status' instead of 'info' for CLI command
  • 87361fa docs: update CLAUDE.md CLI section to reflect 'status' command

Next Steps

Future releases should consider: - Adding more comprehensive CLI commands for advanced device configuration - Implementing async support for high-performance event streaming - Adding batch operation support for setting multiple parameters at once - Expanding CLI help text with more examples and device-specific guidance