Command-line interface

kwalitee comes with a command-line tool that goes by the name of kwalitee. If you’ve installed it using the --user option, you’ll have to add ~/.local/bin to your path. Otherwise, you should be able to call it without any trouble.

$ export PATH+=:~/.local/bin

Help

The command line tool is able to give you direct little help.

$ kwalitee --help

check

Utility to run various kwalitee checks in your repository.

Messages

message

Runs the checks on the existing commits.

$ kwalitee check message master..

githooks

This tool can install or uninstall some hooks into the current git repository.

See also

• kwalitee.cli.githooks
• kwalitee.hooks

Hooks

pre-commit

Runs the checks on the files about to be commited.

prepare-commit-msg

Based on the state of the commit create a commit message to be filled in.

See also

kwalitee.config.COMMIT_MSG_TEMPLATE

post-commit

Verifies that the commit message passes the checks.

Installation

$ kwalitee install

Uninstallation

$ kwalitee uninstall

account

Utililty to manage to user account that have registred.

Listing

$ kwalitee account list

Creation and modification

Creation and modification are using the add command. You can alter the user’s email and its GitHub API token. Any user with a token will have the comments posted on his repository made using the token’s account instead of the default one.

$ kwalitee account add <ACCOUNT>

$ kwalitee account add <ACCOUNT> --email <EMAIL> --token <TOKEN>

See also

kwalitee.config.ACCESS_TOKEN

Deletion

Deletion is permanent and it deletes everything belonging to the given account.

$ kwalitee account remove <ACCOUNT>

repository

Utility to manage to user’s repositories.

Listing

$ kwalitee repository list

Creation

$ kwalitee repository add <ACCOUNT>/<REPOSITORY>

Deletion

Deletion is permanent and it deletes everything belonging to the given repository.

$ kwalitee repository remove <ACCOUNT>/<REPOSITORY>