git-upstream

Utility to set the remote "upstream" on forked repository

Usage no npm install needed!

<script type="module">
  import gitUpstream from 'https://cdn.skypack.dev/git-upstream';
</script>

README

git-upstream

CircleCI Greenkeeper badge

Utility to set the remote "upstream" on forked repository.

Usage

Options:
  --help       Show help                                               [boolean]
  --version    Show version number                                     [boolean]
  --set, -i    Set upstream to a remote               [boolean] [default: false]
  --force, -f  Force overwrite even if upstream already exists
                                                      [boolean] [default: false]
  --token, -t  GitHub access token for private repository               [string]
  --shallow    Prefer parent fork(default) or ancestor fork
                                                       [boolean] [default: true]
  --https      Set https url to remote, otherwise set ssh url
                                                      [boolean] [default: false]

Examples:
  npx git-upstream                     Show upstream url
  npx git-upstream --set               Set upstream with confirmation
  npx git-upstream --set -f            Set upstream even if upstream already
                                       exists
  npx git-upstream --set --https       Set https://...
  npx git-upstream --set --no-shallow  For deep nested fork

Contribution

  1. Fork this repository
  2. Write your code
  3. Run tests
  4. Create pull request to master branch

Development

git clone git@github.com:Leko/git-upstream.git
cd git-upstream
npm i

License

This package under MIT license.