default-branch

Get the default branch of a GitHub repository

Installation

$ npm install default-branch

Usage

const defaultBranch = require('default-branch');

defaultBranch('knutkirkhorn/emorjis').then(branch => {
    console.log(branch);
    // => main
});

defaultBranch('https://github.com/knutkirkhorn/btc-value-cli').then(branch => {
    console.log(branch);
    // => main
});

defaultBranch('https://enterprise.github.corp/org/repo').then(branch => {
    console.log(branch);
    // => default
});

API

defaultBranch(path)

Returns the default branch of a repository. The path can be username/repo-name, or a full url to the repository (example: https://github.com/knutkirkhorn/btc-value-cli).

Related

• has-license - Check if a repository has a license
• gh-repo-has-license - Check if a GitHub repository has a license

License

MIT © Knut Kirkhorn