~bmp/hayom

ref: 5c59bcb4c3f69aab08d57d2f88fd5b8e5c0db160 hayom/README.md -rw-r--r-- 3.0 KiB
5c59bcb4Benjamin Pollack change temp file to *.hayom 6 months ago

#Hayom

Hayom is a rewrite (and gradual reimagining) of jrnl. As-is, it solves exactly one thing: it's not written in Python, and therefore doesn't do your choice of breaking constantly when the system Python gets changed, or having to maintain your own pyenv/virtualenv/what-have-you.

The file format of Hayom is identical to jrnl, so it's easy to point both tools to the same file if you wish (at least for now) and use them interchangeably. Over time, this likely will change in a subtle and fairly backwards-compatible way, for the basic reason that I want a blank line between the entry title and the entry body. But for now, you're golden.

#Installation

deno install -n hayom --allow-env --allow-read --allow-write --allow-run \
    https://git.sr.ht/~bmp/hayom/blob/main/cli.ts

#Usage

Writing entries with Hayom is designed to be as easy as possible so there is no friction. For short entries, it's trivial to just write it right on the command line:

hayom Today, I ate some pancakes. They were delicious.

Everything up to the end of the first sentence will be considered the entry title. It's fine to have just a title.

For longer entries, just type hayom, and it'll pop up an editor. Hayom will honor the editor setting in its config file first, $EDITOR second, and attempt to use nano last.

To read entries, you must specify any of the filtering commands. These commands are:

  • --from/-f: the earliest timestamp to include
  • --to/-t: the last timestamp to include
  • --summary/-s: show just entry titles, not bodies
  • --count/-n: how many entries to show
  • --on: show entries made on a specific day

You can additionally specify tags (formatted as @tagname) to filter entries.

All of the time based commands take natural English, not just dates. For example, this gives you all the entries between last month and this month that were about @bob's @tpsreport:

hayom -f '2 months ago' -t 'this month' @bob @tpsreport

Or, if you're curious what you did last Tuesday, it's as easy as writing:

hayom --on 'last Tuesday'

#Multiple Journals

You can have multiple journals. If you do, the very first word on the command line will specify the journal to use, and does not need to be done as a command format. For example, if I have a journal called work and a journal called personal, I might do

hayom work Finally filed my stupid @tpsreport
hayom personal Sent out a pile of résumés today

#Configuration

Hayom works fine with no configuration file. If you do that, it will make a journal called .journal in your $HOME. Alternatively, you can create a file called $XDG_CONFIG_HOME/hayom/hayom.toml with your configuration options. An example configuration file might look like:

editor = "kak"
default = "personal"

[journals.work]
journal = "/home/benjamin/journals/work.txt"

[journals.personal]
journal = "/home/benjamin/journals/personal.txt"