Skip to content

Standardise CLI switches and --help across all commands #22

@bwyard

Description

@bwyard

Problem

CLI switches and --help haven't been implemented consistently across commands. The score playlist PR (#20) added --shuffle and --help but there's no project-wide standard for how these should work.

Goal

Define and implement a consistent pattern for:

  • Boolean flags / switches (e.g. --shuffle, --watch, --verbose)
  • --help / -h output format and content
  • Short aliases (e.g. -s for --shuffle)
  • Error messaging when invalid flags are passed

Industry standard reference

Look at tools like git, esbuild, vite CLI for patterns. Key decisions:

  • Flag parsing library or hand-rolled?
  • --help shows usage inline or defers to docs?
  • Unknown flags: error or ignore?

Scope

Apply consistently to all existing commands: play, repl, playlist (and any future commands).

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions