get-changelog v1.1.0

get-changelog

A CLI tool to easily find changelogs

Searching for changelogs before upgrade is often a time consuming task. The purpose of this tool is to simplify this search using common changelog locations.

How it works

1. find git repository using npm registry
2. find changelog in the repository (changelog, history or github versions)
3. output results in the terminal

Install

npm install -g get-changelog

CLI Usage

Usage: get-changelog [options]

Options:
  -v, --version              output the version number
  -c, --check                check package.json upgrades using npm-check-updates
  -m, --module <moduleName>  get changelog for an npm module
  -o, --open                 open changelog url with the default browser (only usable with -m)
  --cache                    use cache to improve performances
  -h, --help                 display help for command

Examples

-m, --module

-c, --check

API usage

const ChangelogFinder = require('get-changelog');

(async () => {
    const changeLogFinder = new ChangelogFinder();
    const changelogUrl = await changeLogFinder.getChangelog('express');
    console.log(changelogUrl); // https://github.com/expressjs/express/blob/master/History.md
})();

LICENSE

MIT: LICENSE