Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Git Haiku

Overview

Git Haiku is a unique command-line tool that transforms your Git commit history into creative haiku poems. It combines the technicality of version control with the art of poetry, allowing developers to reflect on their work in a fun and engaging way.

Features

  • Generates Haikus: Turns your recent Git commits into structured haikus, providing a playful summary of your development efforts.
  • Real-Time Commit Analysis: Uses your actual commit messages to create meaningful poems, ensuring each haiku is relevant to your work.
  • Lightweight and Easy to Use: Install and run with a simple command; no additional setup required.

Installation

You can quickly use Git Haiku without installation using npx. Just run:

npx git-haiku

Alternatively, you can install it globally using npm:

npm install -g git-haiku

Usage

Navigate to your Git repository and run:

git-haiku

You’ll receive a haiku generated from your latest commits, bringing a bit of creativity to your coding routine.

Example Output

Generated Haiku:
 rendering faster
 loading image features
 new tests unit of

Contribution

Contributions are welcome! If you have ideas for improvements or new features, feel free to fork the repository and submit a pull request.

To Do

  • Add options for different poem styles beyond haikus.
  • Implement custom filters for word selection.
  • Enhance error handling for repositories with fewer commits.

License

This project is open-source and available under the MIT License. See the LICENSE file for more information.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages