# get-changelog

> CLI tool to easily get changelogs

Latest version **1.1.0** (published 2020-04-19) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install get-changelog
pnpm add get-changelog
yarn add get-changelog
bun add get-changelog
```

Provides the command `get-changelog`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-04-19 |
| First published | 2020-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 179.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 22 |
| Author | CS |
| Maintainers | clement134 |
| Keywords | cli, changelog, npm, versioning |

## Links

- npm: https://www.npmjs.com/package/get-changelog
- Repository: https://github.com/Clement134/get-changelog
- Homepage: https://github.com/Clement134/get-changelog#readme
- Issues: https://github.com/Clement134/get-changelog/issues
- npm.io page: https://npm.io/package/get-changelog

## Dependencies (8)

- [got](https://npm.io/package/got.md) ^10.7.0
- [ora](https://npm.io/package/ora.md) ^4.0.3
- [open](https://npm.io/package/open.md) ^7.0.3
- [semver](https://npm.io/package/semver.md) ^7.3.2
- [commander](https://npm.io/package/commander.md) ^5.0.0
- [registry-url](https://npm.io/package/registry-url.md) ^5.1.0
- [terminal-link](https://npm.io/package/terminal-link.md) ^2.1.1
- [npm-check-updates](https://npm.io/package/npm-check-updates.md) ^4.1.2

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2020-04-19
- 1.0.0 — 2020-04-11
- 0.1.1 — 2020-03-18
- 0.1.0 — 2020-03-08
- 0.0.1 — 2020-03-01

## README

# get-changelog ![version](https://img.shields.io/npm/v/get-changelog?style=flat-square) ![license](https://img.shields.io/npm/l/get-changelog?style=flat-square) ![codecov](https://img.shields.io/codecov/c/github/Clement134/get-changelog?style=flat-square&token=9901e2953c0a42f9937bd0045cdc649b)

> 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

![Module example](/images/module-example.png)

#### -c, --check

![Check example](/images/check-example.png)

## API usage

```javascript
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](/LICENSE)

---
_Source: https://npm.io/package/get-changelog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
