GitWit Commands

GitWit has commands for installing, uninstalling, creating standardized commits, validating messages, and generating changelogs.

This page documents each command, its options, and usage examples.

💡 Tip:

To see help for any command, run:

gitwit <command> --help

🔹 Main Command (gitwit)

The main command provides access to all functionality.

Usage:

gitwit [-dhV] [-ce] [COMMAND]

Option	Description
-d, --debug	Enables debug mode, displaying additional information during execution.
-ce, --config-example	Generates an example .gitwit file in the current directory.
-h, --help	Displays general help.
-V, --version	Displays the installed version.

⚙️ install

Installs GitWit in the current repository or globally for all repositories.

Usage:

gitwit install [-fghV] [-hk]

Option	Description
-hk, --hook	Installs as a prepare-commit-msg hook in the current repository.
-g, --global	Installs as a global Git alias, available in all repositories.
-f, --force	Forces the installation, overwriting an existing hook.
-h, --help	Shows command help.
-V, --version	Shows the version.

⚠️ Warning

The --hook and --global options cannot be used simultaneously.

Examples:

# Installs in the current repository as a Git alias
gitwit install

# Installs globally as a Git alias
gitwit install --global

# Installs GitWit as a hook in the current repository
gitwit install --hook

❌ uninstall

Removes the GitWit installation from the current repository or globally.

Usage:

gitwit uninstall [-ghV] [-hk]

Option	Description
-hk, --hook	Removes the prepare-commit-msg hook from the current repository.
-g, --global	Removes the global GitWit alias.
-h, --help	Shows command help.
-V, --version	Shows the version.

⚠️ Warning

The --hook and --global options cannot be used together.

Examples:

# Removes the alias from the current repository
gitwit uninstall

# Removes the global installation
gitwit uninstall --global

# Removes the hook from the current repository
gitwit uninstall --hook

📝 commit

Launches the interactive commit wizard or allows you to pass data directly via parameters.

Usage:

gitwit commit [-ahV] [-am] [-d=<shortDescription>] [-l=<longDescription>] [-s=<scope>] [-t=<type>]

Option	Description
-a, --add	Automatically adds all modified and untracked files.
-am, --amend	Modifies the last commit instead of creating a new one.
-t, --type=<type>	Commit type (feat, fix, chore, etc.).
-s, --scope=<scope>	Commit scope (core, ui, auth, etc.).
-d, --description=<shortDescription>	Brief description of the commit.
-l, --long-description=<longDescription>	Detailed description of the commit.
-h, --help	Show help.
-V, --version	Show the version.

Examples:

# Interactive wizard
gitwit commit

# Direct commit with parameters
gitwit commit -t feat -s core -d "adds log support"

# Commit with files already added and modifications to the last commit
gitwit commit --amend --add -t fix -s api -d "fixes JWT authentication"

🔍 lint

Validates commit messages based on the rules defined in .gitwit.

Usage:

gitwit lint [-hV] [-f=<from>] [-t=<to>]

Option	Description
-f, --from=<from>	Initial commit (inclusive). Default: HEAD.
-t, --to=<to>	Final commit (inclusive).
-h, --help	Show help.
-V, --version	Show the version.

Examples:

# Lint the last commit
gitwit lint

# Lint a range of commits
gitwit lint --from v1.0.0 --to v1.1.0

📜 changelog

Generates a formatted changelog from commit messages.

Usage:

gitwit changelog [-chV] -f=<from> [-t=<to>]

Option	Description
-f, --from=<from>	Starting point (hash, tag, or branch).
-t, --to=<to>	Ending point. Default: HEAD.
-c, --copy	Copies the generated changelog to the clipboard.
-h, --help	Show help.
-V, --version	Show the version.

Examples:

# Generate changelog since the last tag
gitwit changelog --from v1.0.0

# Generate changelog and copy to the clipboard
gitwit changelog --from v1.0.0 --to v1.2.0 --copy