agentleFS
getedgehqgetedgehq/skills/cli-ux-review/SKILL.md

cli-ux-review

Skill5 starsChanged 11 days agoApache-2.0View on GitHub

Audit a command-line tool for user-friendliness — clear situation / next-step / options in every output, colour-highlighted runnable commands, no raw jargon, no silent hangs. Invoke for "CLI UX audit", "review my CLI", "is this CLI intuitive", or before any CLI release.

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 6 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before every CLI release

    line 13
  2. Distinctive:

    After adding or changing any CLI command

    line 14
  3. Distinctive:

    Every command output must answer three questions:

    line 17
  4. Distinctive:

    Next step present: Every success / terminal state ends with the next command, or an explicit "you are done." No command stalls silently.

    line 25
  5. Distinctive:

    No raw internals: No enum values, state codes, or jargon in user output.

    line 29
  6. Distinctive:

    Errors embed the fix: Every error names the exact command that resolves it.

    line 35

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

CLI UX Review

Audits a CLI against a fixed rubric, from the perspective of a non-developer who has never used it.

When to invoke

  • "CLI UX audit" / "review my CLI" / "is this CLI intuitive"
  • Before every CLI release
  • After adding or changing any CLI command

The frame

Every command output must answer three questions: What is the situation? · What are the next steps? · What can I do?

Quality bar: a command ends the way Codex ends a session — a line of plain status, then the exact next command, rendered in a distinct colour so the eye lands on "type this."

Rubric (score each command against all 7)

  1. Next step present. Every success / terminal state ends with the next command, or an explicit "you are done." No command stalls silently.
  2. Commands are colour-highlighted. Runnable commands render in one consistent accent (cyan + bold). Never bare text, never literal backticks.
  3. No raw internals. No enum values, state codes, or jargon in user output. Human words plus a one-line legend ("dirty" becomes "local edits").
  4. No silent hang. Long-running or stdio commands announce themselves on a TTY, so the terminal never looks frozen.
  5. Consistent primitives. One glyph set, one row/table helper, one next-step block, shared across commands, not re-invented per command.
  6. Errors embed the fix. Every error names the exact command that resolves it.
  7. Guided first run. Bare invocation or a not-logged-in state shows a numbered quickstart.

How to run

  1. Inventory every command and every output path. Read the source, not just --help.
  2. For each command, walk the success path, every error path, and empty states.
  3. Score against the 7 rubric points. Cite file:line for each finding.
  4. Where it fails, write the concrete before / after with the exact strings.
  5. Output: cross-cutting issues, a per-command table, ranked before/after fixes, and an execution plan.

Output format

A findings doc: TL;DR and core problem, cross-cutting issues table, per-command findings, before/after for each fix, execution plan. Never write "looks fine" without having walked the actual output path that proves it.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.