#hello-hut
hello-hut is a small, friendly greeting tool for your terminal. It says hello — and that is all it does.
#Installation
pip install hello-hut
See docs/install.md for other ways to install it, including running straight from a checkout.
#Usage
$ hello-hut
Hello, friend!
$ hello-hut Ada
Hello, Ada!
$ hello-hut Ada --shout
HELLO, ADA!
$ hello-hut --time-of-day Grace
Good evening, Grace!
#Options
| Option | Description | Default |
|---|---|---|
NAME |
Who to greet | friend |
--shout |
Print the greeting in capitals | off |
--time-of-day |
Say good morning, afternoon or evening | off |
--count N |
Repeat the greeting N times |
1 |
--color WHEN |
auto, always or never; NO_COLOR is respected |
auto |
--format FORMAT |
text or json |
text |
#Configuration
Defaults can live in ~/.config/hello-hut/config.toml:
name = "Ada"
shout = false
Every key is described in docs/configuration.md.
#Roadmap
- [x] Positional
NAMEargument - [x]
--shoutand--time-of-day - [x] Configuration file
- [x]
--count,--colorand--format json - [x] Bash and zsh completions
- [ ] Localized greetings with
--lang - [ ] A man page
- [ ]
Rhyming greetings(out of scope, see the tracker)
#Contributing
Patches are welcome on the hello-hut-devel mailing list and bugs go to the tracker. Release announcements are sent to hello-hut-announce. Please read docs/contributing.md first.
#License
MIT — see LICENSE.