@octoherd/script-rename-master-branch-to-main

script-rename-master-branch-to-main

Renames the default branch to main if it is currently set to master

Usage

Note: Your GitHub account must have owner or admin permission in order to rename the default branch on a repository

Minimal usage

npx @octoherd/script-rename-master-branch-to-main

Pass all options as CLI flags to avoid user prompts

npx @octoherd/script-rename-master-branch-to-main \
  -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
  -R "octoherd/*"

Options

option	type	description
--octoherd-token, -T	string	A personal access token (create). 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

Contributing

See CONTRIBUTING.md

About Octoherd

@octoherd is project to help you keep your GitHub repositories in line.

License

ISC