agentleFS
Sign inStart free
pesappesap/skills/cli-ux/SKILL.md

cli-ux

Skill1 starsChanged 3 months agoMITView on GitHub

Treat arguments, streams, output formats, errors, and exit codes as a public interface for both people and automation. 1. Start from the terminal user journey: install, discover command name, tab-complete, run first command, ask for help, then compose/automate. 2. Optimize time-to-value: show likely first commands, concise examples, and next steps before exhaustive docs. 3. Provide -h/--help on the main command and subcommands; keep help fast, predictable, searchable, and example-rich. 4. Use familiar names and a consistent command tree so users…

3 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions3 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 3

    1. vercel/vercel★ 16ksame name
    2. swyxio/skills★ 194same name
    3. hishamkaram/claude-code-router★ 12same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository14 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

9 rules. 0 are common, 7 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Treat arguments, streams, output formats, errors, and exit codes as a public interface for both people and automation.

    line 14
  2. Distinctive:

    Start from the terminal user journey: install, discover command name, tab-complete, run first command, ask for help, then compose/automate.

    line 19
  3. Distinctive:

    Use familiar names and a consistent command tree so users can guess commands from prior commands.

    line 25
  4. Distinctive:

    Treat CLI arguments as a public API: avoid breaking changes.

    line 27
  5. Distinctive:

    Use streams correctly: data on stdout, diagnostics on stderr, accept stdin where useful, and return meaningful exit codes.

    line 31
  6. Distinctive:

    Keep non-interactive mode first-class.

    line 33
  7. Very specific:

    Prefer structured output flags (--json, --yaml, or stable line formats) for parsing and assistive tooling.

    line 39
  8. Distinctive:

    Read CLI UX principles when source-derived principles or trade-offs need more detail.

    line 46
  9. Very specific:

    Use evals/trigger-prompts.json only when tuning recognition and evals/evals.json only when grading review quality.

    line 48

“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “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

Treat arguments, streams, output formats, errors, and exit codes as a public interface for both people and automation.

Core contract

  1. Start from the terminal user journey: install, discover command name, tab-complete, run first command, ask for help, then compose/automate.
  2. Optimize time-to-value: show likely first commands, concise examples, and next steps before exhaustive docs.
  3. Provide -h/--help on the main command and subcommands; keep help fast, predictable, searchable, and example-rich.
  4. Use familiar names and a consistent command tree so users can guess commands from prior commands.
  5. Treat CLI arguments as a public API: avoid breaking changes; document unstable human output versus stable machine/porcelain output.
  6. Validate input early and make errors human-readable: what happened, why, likely owner, how to fix, and where to get details.
  7. Use streams correctly: data on stdout, diagnostics on stderr, accept stdin where useful, and return meaningful exit codes.
  8. Keep non-interactive mode first-class. Interactive prompts can guide humans, but must not replace flags/config for automation.
  9. Make output accessible by default: boring, linear, grepable, screen-reader-friendly, and useful when redirected.
  10. Gate visual affordances: color only on TTY and never when NO_COLOR; no animation/spinners when not TTY, TERM=dumb, CI, or --no-animation.
  11. Prefer structured output flags (--json, --yaml, or stable line formats) for parsing and assistive tooling.
  12. For destructive operations, include dry-run/preview and explicit confirmation controls.

Reference router

  • Read CLI UX principles when source-derived principles or trade-offs need more detail.
  • Use evals/trigger-prompts.json only when tuning recognition and evals/evals.json only when grading review quality.

Output

  • CLI UX verdict.
  • User journey risks and accessibility risks.
  • Recommended command/help/output/error changes.
  • Automation contract: streams, exit codes, structured output, non-interactive behavior.
  • Validation plan: examples, golden output, accessibility/plain-mode checks, and backwards-compatibility checks.

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.

Check your setup, free