#date-time #moon #command-line #phase #emoji #command-line-utilities #date-parser

app moon-phases

Fast command-line application to show the moon phase

6 releases

0.3.3 Oct 2, 2023
0.3.2 Oct 2, 2023
0.2.0 Oct 2, 2023
0.1.0 Oct 2, 2023

#300 in GUI

22 downloads per month

Custom license

12KB
250 lines

moon-phases

Command-line application to show the moon phase for a given date and time, as a text string, emoji, or numeric value. It can also show the moon sign.

Designed to be fast, for use in window manager bars, shell prompts and the like. (On a raspberry pi 4, latency has been under 10ms for all modes; on a modern desktop, under 1.5ms.)

Based on the Schaefer algorithm as implemented by Fallen4Eyes's crate moon-phase. Accepts dates in any format from crate human-date-parser, such as:

  • "2023-10-31"
  • "2023-10-31 13:12:00"
  • "Friday"
  • "next Friday"
  • "in a month"
  • "a year ago"

Includes an option to set Unicode variation characters for colour emoji or monochrome text. See --help for documentation.

Examples

$ moon-phases
Waning Gibbous
$ moon-phases 2023-10-31
Full
$ moon-phases --emoji  # color or monochrome left for system to decide
🌕
$ moon-phases --text-emoji # displays as monochrome in browsers etc.
🌕︎
$ moon-phases --face-emoji "in 7 days"
🌜
$ moon-phases --numeric
0.60
$ moon-phases --numeric "next Friday"
0.94
$ moon-phases --zodiac
Taurus
$ moon-phases --zodiac --emoji
♉

TODO

  • Calendar display
  • Translations for moon phase names

BUGS

Panicking when passed dates out of range rather than gracefully exiting (reported to human-date-parser https://github.com/technologicalMayhem/human-date-parser/issues/1 )

Dependencies

~5–15MB
~202K SLoC