clparse
clparse
is a command line tool for parsing CHANGELOG files that use the Keep
A Changelog format. The CHANGELOG file can be Markdown, JSON, or YAML format
and can also be output into any of those formats once parsed.
Installation
Homebrew
$ brew install marcaddeo/clsuite/clparse
Debian
$ curl -LO https://github.com/marcaddeo/clparse/releases/download/0.5.0/clparse_0.5.0_amd64.deb
$ sudo dpkg -i clparse_0.5.0_amd64.deb
Linux
$ curl -LO https://github.com/marcaddeo/clparse/releases/download/0.5.0/clparse-0.5.0-x86_64-unknown-linux-musl.tar.gz
$ tar czvf clparse-0.5.0-x86_64-unknown-linux-musl.tar.gz
$ sudo mv clparse /usr/local/bin/clparse
Cargo
$ cargo install --git https://github.com/marcaddeo/clparse
Usage
clparse 0.5.0
Marc Addeo <hi@marc.cx>
A command line tool for parsing CHANGELOG.md files that use the Keep A Changelog format.
USAGE:
clparse [OPTIONS] <FILE>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-f, --format <format> Sets the output format of the parsed CHANGELOG [default: markdown] [possible values: json,
yaml, yml, markdown, md]
ARGS:
<FILE> The CHANGELOG file to parse. This should be either a Markdown, JSON, or Yaml representation of a
changelog. Use '-' to read from stdin.
Examples
By default, clparse
will parse the input file, and output the changelog in
markdown format.
$ clparse CHANGELOG.md
-
-
-
-
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
We can transform the markdown into a format that can be easily used in scripts:
$ clparse -f json CHANGELOG.md
clparse
can also parse JSON and YAML representations of the changelog:
$ clparse CHANGELOG.json
-
-
-
-
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
And finally, we can read from stdin by passing -
as the FILE
argument:
-
-
-
-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).