Skip to content

Commit fcecf3b

Browse files
octoherd[bot]gr2m
andauthored
feat: all --octoherd-* flags are now optional (#3)
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]>
1 parent f118d05 commit fcecf3b

File tree

4 files changed

+296
-1225
lines changed

4 files changed

+296
-1225
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,17 @@
55
## Usage
66

77
```
8-
npx @octoherd/script-add-octoherd-cli-to-script \
9-
--octoherd-token 0123456789012345678901234567890123456789 \
10-
"octoherd/*"
8+
npx @octoherd/script-add-octoherd-cli-to-script
119
```
1210

11+
## Options
12+
13+
| option | type | description |
14+
| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15+
| `--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 |
16+
| `--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 |
17+
| `--octoherd-bypass-confirms` | boolean | Bypass prompts to confirm mutating requests |
18+
1319
## License
1420

1521
[ISC](LICENSE.md)

0 commit comments

Comments
 (0)