also looking at this
feat(cli): restore the affordances the docs promised
#1402
6 files
+150
-8
| @@ -12,12 +12,15 @@ buddy open-settings [options] | ||
| 12 | 12 | |
| 13 | 13 | ### Description |
| 14 | 14 | |
| 15 | Quickly open the GitHub settings pages needed to configure permissions for buddy. It opens the repository's Actions settings, follows with the organization's, and prints the exact options to change on each. | |
| 15 | Quickly open the GitHub settings pages needed to configure permissions for buddy. By default it opens the repository's Actions settings, follows with the organization's, and prints the exact options to change on each. | |
| 16 | ||
| 17 | Organization settings do not exist for a repository owned by a personal account, so `--type repo` is the quieter choice there. | |
| 16 | 18 | |
| 17 | 19 | ### Options |
| 18 | 20 | |
| 19 | 21 | | Option | Description | Default | |
| 20 | 22 | |--------|-------------|---------| |
| 23 | | `--type <scope>` | Which settings to open: `repo`, `org` or `both` | `both` | | |
| 21 | 24 | | `--verbose, -v` | Enable verbose logging | `false` | |
| 22 | 25 | |
| 23 | 26 | ### Examples |
| @@ -26,6 +29,12 @@ Quickly open the GitHub settings pages needed to configure permissions for buddy | ||
| 26 | 29 | # Open the Actions settings pages for this repository |
| 27 | 30 | buddy open-settings |
| 28 | 31 | |
| 32 | # Only this repository's settings, skipping the organization | |
| 33 | buddy open-settings --type repo | |
| 34 | ||
| 35 | # Only the organization's, when repository permissions are already correct | |
| 36 | buddy open-settings --type org | |
| 37 | ||
| 29 | 38 | # Show how the repository was resolved |
| 30 | 39 | buddy open-settings --verbose |
| 31 | 40 | ``` |