Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sdh100shaun/script-octoherd-repo-rename
https://github.com/sdh100shaun/script-octoherd-repo-rename
octoherd-script
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sdh100shaun/script-octoherd-repo-rename
- Owner: sdh100shaun
- License: other
- Created: 2023-01-28T16:56:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-28T23:01:05.000Z (almost 2 years ago)
- Last Synced: 2024-04-26T13:21:58.946Z (9 months ago)
- Topics: octoherd-script
- Language: JavaScript
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# script-octoherd-repo-rename
> Renames a repository using find and replace
## Usage
Note: Your GitHub account must have owner or admin permission in order to rename the repository
*WARNING* Can do a partial rename across multiple repositories if find is matched.
Minimal usage
```js
npx sdh100shaun/script-octoherd-repo-rename
```
Pass all options as CLI flags to avoid user prompts
```js
npx sdh100shaun/script-octoherd-repo-rename \
-T ghp_0123456789abcdefghjklwxyzA \
-R "sdh100shaun/*"
--find 'old-repo-name'
--replace 'new-repo-name'
--octoherd-bypass-confirms true
```
## 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 |
| `--find` |string | text to find in repository name |
| `--replace` |string | text to replace in repository name |
| `--octoherd-bypass-confirms` | boolean | Bypass prompts to confirm mutating requests |
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## About Octoherd
[@octoherd](https://github.com/octoherd/) is project to help you keep your GitHub repositories in line.
## License
[MIT](LICENSE.md)