monk 0.3.4

Monk is a simple Git hooks manager written in Rust. It allows you to manage and automate Git hooks easily using a YAML configuration file.
Documentation

Monk's features:

  • 🦀 Easily set up in your Rust project. No need to install additional package managers.
  • ⚙️ Works with custom build.rs files. Automate the hooks installation process.
  • 💻 Run your hooks via CLI. Test your hooks without triggering them via Git.

Keep calm, monk will protect your repo!

Installation

You can install it using cargo:

cargo install monk

Or

You can add it as a build dependency:

cargo add --build monk

Then create a build.rs file:

pub fn main() {
    monk::init();
}

In this case, monk will be installed automatically and will initialize all hooks from monk.yaml . This is the most convenient option for Rust projects, as it doesn't require contributors to install monk manually.

Installing monk with Nix

You can also install monk using Nix:

nix profile install github:daynin/monk

Installing monk with Guix

You can install monk using GNU Guix directly from GitHub:

# Install latest version from main branch
guix package -f <(curl -s https://raw.githubusercontent.com/daynin/monk/main/monk.scm)

Note: This will automatically fetch and build the latest version from the main branch.

Usage

Create a configuration file named monk.yaml in your project root:

Simple Configuration

pre-commit:
  commands:
    - cargo fmt -- --check
    - cargo clippy -- -D warnings

pre-push:
  commands:
    - cargo test

Path-Based Configuration

For projects with multiple modules or mixed technologies, you can configure different hooks for different paths:

pre-commit:
  paths:
    "api/":
      commands:
        - cargo fmt -- --check
        - cargo clippy -- -D warnings
      working_directory: "api"
    "frontend/":
      commands:
        - npm run lint
        - npm test
      working_directory: "frontend"
    "shared/":
      commands:
        - cargo fmt -- --check
        - cargo clippy -- -D warnings
        - cargo test
      working_directory: "shared"

pre-push:
  paths:
    "api/":
      commands:
        - cargo test
        - cargo build --release
      working_directory: "api"
    "frontend/":
      commands:
        - npm run build
      working_directory: "frontend"

# Global hooks (run for any changes)
commit-msg:
  commands:
    - echo "Validating commit message..."

Path-based features:

  • 🎯 Selective execution: Only runs hooks for paths with changed files
  • 📁 Working directory: Each hook can specify its working directory
  • 🔄 Multi-module support: Perfect for monorepos with multiple Rust crates
  • 🌐 Mixed technology: Supports different tech stacks in the same repo

If you installed monk manually, run:

monk install

If you added it as a build dependency and set up build.rs as shown above, the hooks will be installed automatically when you build your project.

Running hooks manually

To run specific hooks manually, use the run command

monk run pre-commit

Removing Hooks

monk automatically creates backup files for existing hooks and restores them when you remove monk's hooks.

To remove the hooks, run:

monk uninstall