Skip to content

MJoseph1234/claiku

Repository files navigation

Claiku

A CLI Haiku assistant


Claiku helps you write haikus from the command line by counting and showing the number of syllables in each line of your poem.

a CLI haiku tool
to count syllables per line
in your three-line poem

CLI Options

Short Form

Use the -s or --short flag to run Claiku in a short(er) form, 3-5-3 syllable mode.

seasons pass
but claiku remains
write haikus

Removing Color

Use --no-color to run the program without using ANSI color codes in the display or output.

Quiet

Use the -q or --quiet flag to skip pritty-printing your new haiku to your terminal. Otherwise, Claiku will clear the terminal and display your completed poem so you can sit back and enjoy it or show it off to a friend.

Saving Your Poems

By default, Claiku saves poems by appending them into a haikus.txt file in the current directory. You can change the output file by specifying a file after the -o or --output flag.

While running Claiku, use CTRL+C to exit the program at any time without saving.

Future

  • Additional options for saving your haiku to file
    • options to include date and timestamps so you can track when you write all of your haikus
  • Saving user configuration so flags and filepaths don't have to be specified every time
  • rewrite in Rust because I'm learning Rust

About

A little python tool to help you write beautiful haikus from the terminal

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages