Smee

Smee is a Git hooks manager.

Mr. Smee is Captain Hook's git. Smee is the Captain of Git hooks!

Features

• Supports project hooks and user hooks
• Only one command: smee — no dependencies!
• Configured entirely with git config — no configuration file!
• Written in Rust 🦀 — small and blazingly fast!
• Comes with a bunch of ready-to-use hooks to get you started/inspired!

Documentation

Git hooks are commands that are run at certain points during Git operations. Their names correspond to the events that trigger their execution: pre-commit, post-rewrite, etc.

Smee helps you organize and run Git hooks.

Start using Smee

To let Smee manage the hooks in a repository, run the following command in that repository:

smee install

Smee distinguishes between two categories of hooks: project hooks and user hooks.

Project hooks

Project hooks are versioned along with the sources of a project and are intended to be run by all contributors. They typically rely on the same tools as the project itself.

Example: a project hook test that runs the test suite of the project before each commit.

Project hooks are stored in a project under the .config/smee/hooks directory (as recommended by the dot-config manifest). If there is only one hook for an event (e.g., pre-commit), it can be stored directly under this directory (e.g., .config/smee/hooks/pre-commit). If there are several hooks, it is recommended to organize them in subdirectories (e.g., .config/smee/hooks/test/pre-commit, .config/smee/hooks/style/pre-commit, etc.).

Project hooks are always run by Smee.

User hooks

User hooks are activated by a user, either for a specific project or for all of them. Since they are not shared with other contributors, they can use tools that are only available on that user's system.

Example: a user hook notifications/commit that displays a notification on each successful commit.

User hooks can be stored anywhere on your system. You register a hooks directory with:

git config set --global --append smee.dirs DIRECTORY

Similarly, you deregister a hooks directory with:

git config unset --global --value=DIRECTORY smee.dirs

Once Smee knows where to look for user hooks, you can activate one or more hooks with:

smee hooks activate [SCOPE] HOOK...

where SCOPE is optional and is either:

• --local to activate the hook in the local project only (the default)
• --global to activate the hook in all projects

Similarly, you deactivate one or more hooks with:

smee hooks deactivate [SCOPE] HOOK...

To list the active user hooks, simply run:

smee hooks list

Note: Since Smee is configured entirely within the Git configuration, you may want to edit the corresponding files directly. This can be useful to examine or reorder the active hooks, for example.

Disable Smee

Sometimes you need to disable Smee for an operation (e.g., you're creating a temporary commit with changes that don't compile). You can do that by setting the SMEE_DISABLE environment variable:

SMEE_DISABLE=1 git commit -a -m 'wip'

Note: The actual value of the variable doesn't matter, as long as it is set.

Note: Some Git commands have a --no-verify option that makes Git not run the hooks. This also disables Smee.

Stop using Smee

If you ever want to stop using Smee in a repository, run the following command in that repository:

smee uninstall

If there were existing hooks when Smee was installed, they will be restored.

Configuration

Smee is configured entirely with the Git configuration, under the smee section.

Key	Description
smee.dirs	Directories where Smee looks for user hooks (multiple values)
smee.hooks	Active user hooks (multiple values)
smee.maxLogLevel	Maximum log level (valid values: OFF, ERROR, WARN, INFO, DEBUG, TRACE)

Hooks

The hooks directory contains a bunch of ready-to-use hooks to get you started. See the README for instructions.

See also Awesome Git hooks for more ideas.

Changelog

See CHANGELOG.

License

Smee is licensed under the Apache License, Version 2.0. See LICENSE.