# chlog-cli

> CLI tool for managing CHANGELOG.md file based on "Keep a Changelog" file format

Latest version **1.0.6** (published 2021-04-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install chlog-cli
pnpm add chlog-cli
yarn add chlog-cli
bun add chlog-cli
```

Provides the commands `chlog`, `chlog-cli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2021-04-03 |
| First published | 2021-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 37.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jaroslav Khorishchenko |
| Maintainers | snipter |
| Keywords | changelog, cli |

## Links

- npm: https://www.npmjs.com/package/chlog-cli
- Repository: https://github.com/husky-dev/chlog-cli
- Homepage: https://github.com/husky-dev/chlog-cli#readme
- Issues: https://github.com/husky-dev/chlog-cli/issues
- npm.io page: https://npm.io/package/chlog-cli

## 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.0.6 (latest) — 2021-04-03
- 1.0.5 — 2021-03-31
- 1.0.4 — 2021-03-31
- 1.0.3 — 2021-03-31
- 1.0.2 — 2021-03-31
- 1.0.1 — 2021-03-31
- 1.0.0 — 2021-03-31

## README

# Changelog CLI

![npm version](https://img.shields.io/npm/v/chlog-cli)
![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)
![Lint](https://github.com/husky-dev/chlog-cli/workflows/Lint/badge.svg)
![Test](https://github.com/husky-dev/chlog-cli/workflows/Test/badge.svg)

CLI tool for managing `CHANGELOG.md` file based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.

## Installation

```bash
npm isntall -g chlog-cli
```

Or use with `npx`:

```bash
npx chlog-cli help
```

## Usage

Init a new changelog:

```bash
chlog init
chlog init changelog.md
```

Get full changelog:

```bash
chlog get
```

Get all changes at `1.50.x` versions:

```bash
chlog get 1.50
```

Add record:

```bash
chlog add -a 1.50.1 "Some new feature"
# Options:
#   -f, --fixed       add to "Fixed"
#   -a, --added       add to "Added"
#   -c, --changed     add to "Changed"
#   -d, --deprecated  add to "Deprecated"
#   -r, --removed     add to "Removed"
#   -s, --security    add to "Security"
```

Add reccord with a link:

```
chlog add -a Unreleased "Some new feature" "https://jira-ticket.com/APP-300"
```

Change version name:

```bash
chlog change 1.50.1 --name 1.50.2
```

Change version date:

```bash
chlog change 1.50.1 --date "2021-01-01"
chlog change 1.50.1 --date current
chlog change 1.50.1 --date cur
```

Remove version:

```bash
chlog remove 1.50.1
```

Get help:

```bash
chlog -h
chlog help
chlog add -h
chlog add --help
```

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