Skip to content

v0.1.60 - CLI Argument Naming Improvements (2025-12-17)

What Changed?

This release improves the clarity and consistency of CLI argument names across all commands and example scripts. Parameter names have been renamed to be more descriptive and self-documenting, making the CLI more intuitive for users. Option flags have also been updated for better readability and consistency.

What's New

CLI Argument and Option Naming Improvements

What it does: Improves CLI usability by using clearer, more descriptive parameter and option names that better convey their purpose.

Key Changes: - event_or_duration → events_or_secs: More explicit about counting events vs. specifying duration in seconds - runs → files: Clarifies that multiple output files are being created, not abstract "runs" - --use-event/--use-duration → --use-event / --use-sec: Shorter, clearer flag names for toggling collection mode

How to use it: All CLI commands now use consistent naming. For example:

# Time-based collection (30 seconds)
kazunoko read 30 --use-sec

# Event-based collection (10 events)
kazunoko read 10 --use-event

# Measure command with new argument names
kazunoko measure "1:300;2:300;3:300" 60 --use-sec

# Example scripts also updated
uv run get_events.py "1:300;2:300;3:310" 100
uv run get_runs.py "1:300;2:300;3:310" 100 10
uv run get_thresholds.py "1:300;2:300;3:310" 100 10

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

  • No new features in this release

🔧 Changed

  • Renamed CLI argument event_or_duration to events_or_secs in all commands and scripts
  • Renamed argument runs to files in multi-file example scripts (get_runs.py, get_thresholds.py)
  • Updated option flag --use-event/--use-duration to --use-event / --use-sec
  • Updated all documentation, examples, and help text to reflect new naming conventions
  • Updated Options class docstrings in options.py

🐛 Fixed

  • None in this release

Is It Safe to Upgrade?

Backward Compatible: No - Breaking Change

  • Users of the CLI will need to update their scripts and commands to use the new argument and option names
  • All programmatic usage is unaffected (only CLI argument names changed)
  • Example scripts have been updated and are provided for reference

Tests Passed

  • ✅ Builds without errors
  • ✅ Pre-commit hooks pass (conventional commits)
  • ✅ All modified files have been reviewed for consistency

Release Details

  • Date: 2025-12-17
  • Version: v0.1.60
  • Files Changed: 6 files
  • src/kazunoko/cli.py
  • src/kazunoko/options.py
  • examples/get_events.py
  • examples/get_runs.py
  • examples/get_thresholds.py
  • Commits: 4 commits
  • refactor: rename event_or_duration to events_or_secs
  • refactor: rename runs to files in get_runs.py
  • refactor: rename use_event option from --use-event/--use-duration to --use-event / --use-sec
  • refactor: update all --use-duration references to --use-sec
  • refactor: rename event_or_duration to events_or_secs and runs to files in get_thresholds.py

Next Steps

  • Add more comprehensive examples in documentation
  • Consider adding CLI alias support for backward compatibility in future versions
  • Continue improving CLI usability based on user feedback