Skip to content

Clarify CLI help text to say what each command is for#50

Merged
rhiever merged 5 commits into
mainfrom
help-text-clarity
Jun 26, 2026
Merged

Clarify CLI help text to say what each command is for#50
rhiever merged 5 commits into
mainfrom
help-text-clarity

Conversation

@rhiever

@rhiever rhiever commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

What

Rewrites the Goodeye CLI help text so each command, group, and the root tagline lead with what a user or agent uses it for, not the mechanism it runs.

Highlights:

  • design, teach, optimize, optimize-description, and audit now make the distinction clear: create a new workflow, improve one by hand, improve one automatically, tune its trigger, or review it against best practices.
  • login-verify and register-verify describe the non-interactive sign-in and sign-up flow without implying it is only for scripts or CI.
  • Replaces dash separators in help strings with colons or semicolons, per brand style.

No capability or behavior change: help text only.

Verification

  • ruff and ruff-format clean
  • 824 tests pass

🤖 Generated with Claude Code

rhiever and others added 5 commits June 26, 2026 11:21
Lead each command, group, and the root tagline with the task a user or
agent accomplishes, not the mechanism it runs. The design, teach,
optimize, and audit commands now make the create, improve, and review
distinction unmistakable. Reword the non-interactive login and register
verify commands so they no longer imply script or CI only, and replace
dash separators in help strings with colons or semicolons.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Align the verifiers and image-generators deploy command summaries with the
deploy command name and the matching server-side wording, and free them from
the reserved 'publish' verb used for the public template catalog.
The workflows command group is private-only, but its tagline used
'publish', which in Goodeye's product language means making something
public (templates publish). That collided with the publish command's
own 'Save to your private registry' wording. Switch the tagline verb to
'save' so it matches the command body and the private framing.
Unpublishing a specific version only sets unpublished_at; there is no
path that restores that version (publishing always appends a new one),
so the help text now distinguishes unpublish from deprecate and delete
instead of promising reversibility.
@rhiever rhiever merged commit c9dc314 into main Jun 26, 2026
1 check passed
@rhiever rhiever deleted the help-text-clarity branch June 26, 2026 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant