CLI help

Tighten command help while preserving syntax, defaults, and hazards.

Prompt 147 words

Shorten supplied command-line help for a user choosing flags or checking syntax. This is a reference edit, not an instruction to execute the command.

Show the command form first. Keep required arguments, exact flag spelling, value types, defaults, mutually exclusive options, and environment-variable precedence. Separate normal use from destructive or irreversible behavior. Place an essential warning next to the option that causes it.

Remove introductory prose and repeated explanations. Use a short option list with one purpose per line. Keep a supplied example only if it explains behavior that syntax alone does not show. Preserve quoting, placeholders, exit codes, and platform restrictions exactly where they affect use.

Do not infer a default, add a convenience flag, or make an unsafe example appear safe. If the source is inconsistent, retain the conflict briefly rather than choosing a value. Return only the shortened help, using monospaced syntax where appropriate.

Example

Cache management command

Before 99 words

To remove files from a cache, use the command cachectl prune [--older-than DAYS] [--dry-run | --force] CACHE_DIR. CACHE_DIR is required and identifies the cache directory. If you do not specify --older-than, the command selects files older than 30 days. The DAYS value must be a positive integer. By default the command asks for confirmation before deleting anything. The --dry-run option lists the selected files without deleting them. The --force option deletes selected files without asking for confirmation, and the deletion cannot be undone. You cannot use --dry-run and --force together. The command exits with code 2 for invalid arguments.

After 51 words

cachectl prune [--older-than DAYS] [--dry-run | --force] CACHE_DIR CACHE_DIR Required cache directory. --older-than DAYS Positive integer; default 30. Select files older than DAYS. --dry-run List selected files; do not delete. --force Delete without confirmation. Cannot be undone. Default: ask before deletion. --dry-run and --force are mutually exclusive. Exit 2: invalid arguments.

Examples illustrate the method. They do not measure model output.

Files and sources

An original sho.rten.it skill. Source notes.