Getting Started

Installation

NPM

A npm package is available of the latest stable. You can install it globally with the below command.

npm i -g @practically/conventional-tools

Docker

There is a docker build of both the latest stable and the next branch. This is meant to be used in CI however there is no reason you cant use it locally if you want to run it in a confined environment

docker run --rm -it registry.k1.zportal.co.uk/practically-oss/conventional-tools:latest conventional-tools --help
docker run --rm -it registry.k1.zportal.co.uk/practically-oss/conventional-tools:next conventional-tools --help

Source

If you want to install the cli from source you will need npm or yarn installed. The below example is installing with yarn on a linux biased environment.

#
# Clone the source
#
git clone https://git.zportal.co.uk/practically-oss/conventional-tools.git ~/.local/share/conventional-tools
#
# Move to the source directory
#
cd ~/.local/share/conventional-tools
#
# Install dependencies and build
#
yarn install && yarn prepack
#
# Link the exe to the bin directory
#
ln -s ~/.local/share/conventional-tools/bin/run ~/.local/bin/conventional-tools