https://github.com/kentcdodds/clog-cli

An npm distribution of the amazing clog tool
https://github.com/kentcdodds/clog-cli

Last synced: about 2 months ago
JSON representation

An npm distribution of the amazing clog tool

• Host: GitHub
• URL: https://github.com/kentcdodds/clog-cli
• Owner: kentcdodds
• Archived: true
• Created: 2015-08-07T12:46:21.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-08-14T19:17:37.000Z (about 8 years ago)
• Last Synced: 2024-07-17T16:03:43.073Z (2 months ago)
• Homepage: https://github.com/clog-tool/clog
• Size: 580 KB
• Stars: 28
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome-command-line-apps - clog - Conventional changelog for the rest of us. (\*nix/\*nux / Developer)

README

        
# clog

A [conventional](https://github.com/ajoslin/conventional-changelog/blob/a5505865ff3dd710cf757f50530e73ef0ca641da/conventions/angular.md) changelog for the rest of us

![Screenshot](other/screenshot.png)

This is just an npm distribution of the amazing [clog](https://github.com/clog-tool/clog).

[I](https://twitter.com/kentcdodds) created this package because I think `clog` is awesome and I think this is an easier

way to distribute it.

# Installation and Requirements

## Requirements

### Mac

Right now, this package only supports the `clog` distribution available for Mac. There are

[other distributions available](http://wod.twentyfives.net/bin/clog/).

### Node & npm

This is distributed as an `npm` package (some say that stands for "Node Package Manager"). So you must have Node.js (or io.js) and npm installed.

Here are quick instructions on how to get those: http://blog.nodeknockout.com/post/65463770933/how-to-install-node-js-and-npm

Congratulations, you've opened your life to a whole new world of awesome tooling and other cool things :-)

## Installation

Install this tool via `npm`: `$ npm install -g clog-cli`

# Usage

In your terminal, simply type `clog --help` to get output of the options available.

See the official [clog](https://github.com/clog-tool/clog) website for documentation on how to use `clog`.

Here's the output when you type `clog`:

```

clog v0.7.0

a conventional changelog for the rest of us

USAGE:

	clog [FLAGS] [OPTIONS]

FLAGS:

        --from-latest-tag    use latest tag as start (instead of --from)

    -h, --help               Prints help information

        --major              Increment major version by one (Sets minor and patch to 0)

        --minor              Increment minor version by one (Sets patch to 0)

        --patch              Increment patch version by one

    -v, --version            Prints version information

OPTIONS:

        --from                     e.g. 12a8546

    -o, --outfile               Where to write the changelog (Defaults to 'changelog.md')

    -r, --repository         e.g. https://github.com/thoughtram/clog

        --link-style              The style of repository link to generate, defaults to github [values: Github, Gitlab, Stash]

        --subtitle <subtitle>            e.g. crazy-release-title

        --to <to>                        e.g. 8057684 (Defaults to HEAD when omitted)

        --setversion <ver>               e.g. 1.0.1

```

# LICENSE

Both this package and the `clog` tool itself are MIT licensed.