Skip to content

Take the firmware file as an update argument - #43

Merged
glopesdev merged 1 commit into
harp-tech:mainfrom
glopesdev:cli-consistency
Sep 14, 2026
Merged

glopesdev merged 1 commit into
harp-tech:mainfrom
glopesdev:cli-consistency

Conversation

@glopesdev

Copy link
Copy Markdown
Contributor

update now takes the firmware file as its argument rather than through a required --path option, matching how generate already takes its metadata path. A required option is a contradiction in terms, and the best name for a command's sole required input is no name at all.

Harp.Toolkit update [<firmware>] [options]

--path is kept as a hidden option for one version, since update is the oldest released command and possibly is used in old scripts. A parse-time validator rejects supplying both, so a script migrating half way does not flash the wrong file to a device.

Option descriptions

Applied the imperative voice for actions and a noun phrase for values, to --port, --timeout, --force and --implementation option descriptions.

@glopesdev glopesdev added the feature New planned feature label Sep 14, 2026
The firmware path is now the argument of the update command, matching
how generate takes its metadata path, so the required input needs no
option name at all. --path is kept as a hidden option for one version,
and a parse-time validator rejects supplying both rather than
preferring one, since a script migrating half way would otherwise flash
a different file.

Option descriptions follow the imperative voice for actions and a noun
phrase for values, and --output no longer repeats a default that
System.CommandLine already renders. That default is now constructed
from a relative path, so help shows it as a dot.
@glopesdev
glopesdev merged commit 1bb814b into harp-tech:main Sep 14, 2026
9 checks passed
@glopesdev
glopesdev deleted the cli-consistency branch September 14, 2026 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New planned feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants