feat: all --octoherd-* flags are now optional (#5)

BREAKING CHANGE: Repositories can no longer be passed as positional argument, use the `--octoherd-repos` (or `-R`) CLI flag instead. Before: ``` npx @octoherd/script-add-octoherd-cli-to-script "@octokit/*" ``` After ``` npx @octoherd/script-add-octoherd-cli-to-script --octoherd-repos "@octokit/*" ``` Or do not set `--octoherd-repos` at all, in which case the user will be prompted. Co-authored-by: Gregor Martynus <[email protected]>
octoherd · Apr 19, 2021 · e2e5146 · e2e5146
1 parent 056de94
commit e2e5146
Show file tree

Hide file tree

Showing 3 changed files with 280 additions and 1,231 deletions.
diff --git a/README.md b/README.md
@@ -5,11 +5,17 @@
 ## Usage
 
 ```
-$ npx @octoherd/script-close-renovate-dashboard-issues \
-  --octoherd-token 0123456789012345678901234567890123456789 \
-    "octokit/*"
+$ npx @octoherd/script-close-renovate-dashboard-issues
 ```
 
+## Options
+
+| option                       | type             | description                                                                                                                                                                                                                                 |
+| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--octoherd-token`, `-T`     | string           | A personal access token ([create](https://github.com/settings/tokens/new?scopes=repo)). Script will create one if option is not set                                                                                                         |
+| `--octoherd-repos`, `-R`     | array of strings | One or multiple space-separated repositories in the form of `repo-owner/repo-name`. `repo-owner/*` will find all repositories for one owner. `*` will find all repositories the user has access to. Will prompt for repositories if not set |
+| `--octoherd-bypass-confirms` | boolean          | Bypass prompts to confirm mutating requests                                                                                                                                                                                                 |
+
 ## Licenses
 
 [ISC](LICENSE.md)