@osdlc/repo-cleaner 0.17.2 → 0.19.0

package/dist/cli.d.ts

@@ -1,27 +1,23 @@
 /**
  * `repo-cleaner` — what has been merged, and what can go away.
  *
- * Four verbs over one set of sweep filters:
+ *   repo-cleaner [target...]   the report; deletes nothing
+ *   repo-cleaner plan          save the sweep's rows and their evidence, to run later
+ *   repo-cleaner clean         check again, show the steps, ask, delete
+ *   repo-cleaner cache         list or remove the clones kept for remote URL targets
  *
- *   status  (the default) inventory and classify; read-only but for the fetch
- *   summary the same sweep as counts: totals, merged, delete, prune, review, keep
- *   plan    write the deletable rows as a plan, to stdout or a file
- *   apply   re-check, show the steps, ask, then delete
- *
- * and `cache`, which lists and removes the clones `--remote-url` keeps.
- *
- * `apply` works from a saved plan (`--plan`) or sweeps first. Either way it
- * re-checks every row, prints the steps it would run and asks before deleting;
- * `--yes` skips the question. Without a terminal and without `--yes` it
- * refuses rather than deleting. Scope is opt-in: the sweep covers the
- * repository you are standing in unless a path says otherwise.
+ * Every command takes `--help`, and `--help --extended` for the full
+ * reference: what each option means, the words the report uses, and which
+ * combinations are refused. A combination that contradicts itself, or one
+ * with an option that would have no effect, is refused with exit 2 before
+ * anything is swept.
  *
  * Exit codes:
- *   0   swept; or apply ran, was declined, or had nothing to run
+ *   0   swept; or clean ran, was declined, or had nothing to do
  *   1   failed against the state it found
  *   2   cannot run as typed
- *   10  nothing to sweep: no entry named a repository
- *   11  apply stopped at a failed step; the receipt says which
+ *   10  no target named a repository
+ *   11  clean stopped at a failed step; the receipt says which
  */
 import { type CliContext } from '@osdlc/cli-tool';
 /**