🤔 What is lullaby?

lullaby is a simple and lightweight command-line interface (CLI) tool that validates your commit messages to ensure they follow the Conventional Commits specification.

With lullaby installed in your project, you can ensure a clean, readable, and standardized commit history, making it easier to automate changelogs and navigate the project's history. No more nightmares about non-standard commit messages!

✨ Features

• Automatic Validation: Uses Git Hooks (commit-msg) to validate messages before each commit.
• Simple Setup: Just one command to configure everything in your repository.
• Lightweight and Fast: Focused on doing one thing well without cluttering your environment.
• Industry Standard: Ensures compliance with the Conventional Commits standard.

🚀 Installation

To use lullaby, install it globally using npm or yarn:

npm install -g @oniryk/llby-cli

Usage

After installation, using it is extremely simple.

1. Authenticate

Before using lullaby, you must authenticate with your access token. This step is required for the tool to work properly.

llby auth <your-access-token>

Replace <your-access-token> with your actual token. If you don't have a token, please refer to the documentation or your account settings to obtain one.

2. Setting up the Hook

Navigate to the root of your repository and run the setup command. This will create the commit-msg hook file inside your .git/hooks folder.

llby setup

Alternative Usage with NPX

If you prefer not to install the package, you can run the setup command directly using npx. This is perfect for a quick, one-time setup on any project.

npx @oniryk/llby-cli setup

3. Committing

That's it! Now, every time you run the git commit command, lullaby will intercept the action, validate your message, and either allow or block the commit based on the Conventional Commits rules.

📄 License

Distributed under the MIT License. See LICENSE for more information.