Improved CLI

[nebbles]

Overview

CLI control should be enhanced. The current proposal is to introduce a number of flags to customise the visual experience of the tool (such as verbose / minimal), and to implement larger additional features as commands.

Example

An example can be seen from woile/commitizen

$ cz --help
usage: cz [-h] [--debug] [-n NAME] [--version]
        {ls,commit,c,example,info,schema,bump} ...

Commitizen is a cli tool to generate conventional commits.
For more information about the topic go to https://conventionalcommits.org/

optional arguments:
-h, --help            show this help message and exit
--debug               use debug mode
-n NAME, --name NAME  use the given commitizen
--version             get the version of the installed commitizen

commands:
{ls,commit,c,example,info,schema,bump}
    ls                  show available commitizens
    commit (c)          create new commit
    example             show commit example
    info                show information about the cz
    schema              show commit schema
    bump                bump semantic version based on the git log

Proposed Commands

• config used to generate, possibly modify repo specific configuration
• version <major|minor|patch> allows single command to increase version numbers
• example shows some examples of the output of the tool
• help provides guidance on the use of the tool
• check (Lint/format string mode (for pre-commit hook) #18) lints the input string to see if it adheres to standards
• format takes a string as input and does its best to auto format to standards

Proposed Flags

• help shows help message
• version shows version of package
• verbose more contextual information given to the committer
• minimal reduce interface to bare minimum
• no-colour removes colour component from formatted text
• spell-check would open message in editor at end to allow for spell checking