Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.19 KB

mit-commit-msg.md

File metadata and controls

48 lines (33 loc) · 1.19 KB
Raw

mit-commit-msg

Note: This is a hook binary, you will probably never interact with it directly

Generic usage

mit-commit-msg --help
Validate the commit message that a user has input

Usage: mit-commit-msg [OPTIONS] [COMMIT_FILE_PATH]

Arguments:
  [COMMIT_FILE_PATH]  Path to a temporary file that contains the commit message written by the
                      developer

Options:
      --copy-message-to-clipboard  On lint failure copy the message to clipboard [env:
                                   GIT_MIT_COPY_MESSAGE_TO_CLIPBOARD=]
      --completion <COMPLETION>    [possible values: bash, elvish, fish, powershell, zsh]
  -h, --help                       Print help
  -V, --version                    Print version

You can generate completion with

mit-commit-msg --completion bash

Otherwise you need an the commit file path

mit-commit-msg
error: the following required arguments were not provided:
  <COMMIT_FILE_PATH>

Usage: mit-commit-msg <COMMIT_FILE_PATH>

For more information, try '--help'.