This project provides tooling support for working with Keep A Changelog.
Run the following to install this library:
$ composer require phly/keep-a-changelogAlternately, install globally, for use with any repository:
$ composer global require phly/keep-a-changelogIf you install globally, ensure you add global composer vendor binaries
directory to your $PATH environment variable. You can get its location with
following command:
$ composer global config bin-dir --absoluteYou can add the following line to your shell profile to auto-add it to your PATH:
export PATH=$(composer global config bin-dir --absolute):$PATHOnce setup this way, you can call keep-a-changelog instead of
./vendor/bin/keep-a-changelog.
Since version 2.3.0, we have offered standalone PHAR binaries. These are available under the downloads section for each release. To retrieve the latest, you can always use the following url:
Make the file executable (e.g., chmod 755 keep-a-changelog.phar), place it in
your $PATH, and, optionally, remove the .phar suffix
At the time of writing, the PHAR distribution is not yet capable of self-updating or checking for updates.
Invocation will be via one of the following:
- If you have installed via Composer within your project:
./vendor/bin/keep-a-changelog - If you have installed globally via Composer, and have added the Composer
script path to your
$PATH:keep-a-changelog. - If you have downloaded the PHAR file and put it in your
$PATH: eitherkeep-a-changelog.pharor, if you removed the.pharfile extension,keep-a-changelog.
From here forward, we will use keep-a-changelog to invoke the command;
substitute the appropriate command invocation based on your install.
You may get a list of commands by running:
$ keep-a-changelogFrom there, you can get help for individual commands using:
$ keep-a-changelog help <command>For more information, please visit the documentation.
