🪝 Hooksmith

                ,"(                             .
               ////\                           /
              (//////--,,,,,_____            ,"
            _;"""----/////_______;,,        //
__________;"o,-------------......"""""`'-._/(
      ""'==._.__,;;;;"""           ____,.-.==
             "-.:______,...;---""/"   "    \(
                 '-._      `-._("           \\
                     '-._                     '._

Git Hook Management Made Simple

Hooksmith is a lightweight, easy-to-use tool that simplifies Git hook management. Define your hooks in a simple YAML file and let Hooksmith handle the rest.

📋 Table of Contents

• ✨ Features
• ⚡ Why Hooksmith?
• 🔧 Installation
• 🚀 Quick Start
• 📖 Usage
• 📚 Command Reference
• 🤝 Contributing
• 📄 License

✨ Features

• ⚙️ Automatic Installation - Set up hooks through your build scripts with build.rs
• 🧪 Local Testing - Run hooks manually without triggering Git events
• 🔍 Dry Run Mode - Preview what would happen without making changes
• ✅ Hook Validation - Ensure your hooks comply with Git standards
• 📝 Simple Configuration - Define all your hooks in a clean YAML format

⚡ Why Hooksmith?

• Minimal Dependencies - Lightweight with only essential dependencies
• Rust Powered - Fast, reliable, and type-safe
• Team Friendly - Version control your hook configurations
• Seamless Integration - Works naturally with your Git workflow
• Low Learning Curve - Simple commands and clear documentation

🔧 Installation

Using Cargo

cargo install hooksmith

As a Build Dependency

Add to your Cargo.toml:

[build-dependencies]
hooksmith = "1.4.3"

Create a build.rs file:

use std::path::Path;

fn main() {
    let config_path = Path::new("hooksmith.yaml");
    hooksmith::init(&config_path);
}

💡 Note: Hooksmith includes shell completions for Fish. After installation, they become available automatically.

🚀 Quick Start

1. Create a hooksmith.yaml file in your project root:

pre-commit:
  commands:
    - cargo fmt --all -- --check
    - cargo clippy -- --deny warnings

pre-push:
  commands:
    - cargo test

2. Install the hooks:

hooksmith install

That's it! Your Git hooks are now ready to use.

📖 Usage

Configuration File

Hooksmith uses a YAML configuration file (default: hooksmith.yaml) to define your hooks:

# Format and lint code before committing
pre-commit:
  commands:
    - cargo fmt --all -- --check
    - cargo clippy --workspace --all-features -- --deny warnings

# Run tests before pushing
pre-push:
  commands:
    - cargo test --all-features
    - cargo build --verbose

# Validate commit messages
commit-msg:
  commands:
    # Use custom script to validate commit messages
    - ./scripts/verify-commit-message.sh $1

Common Commands

# Install all hooks defined in configuration
hooksmith install

# Run a specific hook manually
hooksmith run pre-commit

# Uninstall all hooks or a specific one
hooksmith uninstall
hooksmith uninstall pre-commit

# Compare installed hooks with configuration
hooksmith compare

# Validate hook configuration against Git standards
hooksmith validate

Add --dry-run to any command to preview changes without applying them:

hooksmith install --dry-run

📚 Command Reference

Global Options

🤝 Contributing

Contributions are welcome! Feel free to:

• Report bugs and suggest features
• Submit pull requests
• Improve documentation
• Share your use cases and feedback

📄 License

This project is dual-licensed under either:

• Apache License 2.0
• MIT License

at your option.