This is the website. Build it with tiffy.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

68 lines
2.9 KiB

{{ im ./media/software/almanac.jpg }}
{{ li { Almanac on Codeberg } }}
{{ h1 Almanac.}}
A short form journaling program written in a single shell script for your local machine only. Almanac flies in the face of the trend to have data available to all your devices via the internet; a journal is often a deeply private and personal thing, why would you want to make that available online?
A journal is an item to be cherished and cared for, it must travel with you if you are to be able to use it. The interconnected age has destroyed some of the special relationship with the item of the journal by allowing you to make entries at any time from any medium. Almanac tries to restore some of this special relationship by insisting that if you are to fill it, it must travel with you.
{{ im ./media/software/almanac_screen.png }}
Almanac stores all entries with a subject tag and a time stamp so that it is fully searchable.
{{ h3 Add an entry to the almanac. }}
{{ cb almanac -m "This is the message to log" }}
This will add an entry to the almanac with the default tag of 'personal' or what you have set the tag in the config file to
{{ h3 Add an entry to the almanac with a different tag }}
{{ cb almanac -s work -m "This is the message to log" }}
This will add an entry to the almanac with the tag specified after the -s flag.
{{ h3 Display the whole almanac }}
{{ cb almanac -A }}
This will display all of the entries in the almanac to the cli.
{{ h3 Display all entries for tag }}
{{ cb almanac -S work }}
This will display any entries in the almanac for the given tag.
{{ h3 Display entries by date }}
The -D -Y and -M tags display entries from the given day, year or month respectively. They can be combined like so.
{{ cb almanac -D 01 -M 01 -Y 19 }}
This will display all of the entries for the 1st of January 2019. These can also be combined with a tag search:
{{ cb almanac -S work -Y 19 }}
Will display all of the entries in 2019 with the work tag. Note that all of the date searches require 2 digit inputs e.g. you will need to input 01 instead of just 1
{{ h3 Display used tags }}
{{ cb almanac -T }}
{{ h3 Display the number of posts for each tag }}
{{ cb almanac -C }}
{{ h3 Display the last entry inserted into the almanac }}
{{ cb almanac -l }}
{{ h3 Remove an entry from the almanac }}
{{ cb almanac --remove-entry {the long number at the start of the entry goes here} }}
Note that this has the ability to remove MANY entries from the almanac at once, it works by regex matching the number at the start of the entry. If you put 010119 then any entries with a number that starts 010119 will be permanently removed from the log. THIS CAN NOT BE UNDONE SO IF YOU REMOVE THINGS YOU WANT TO KEEP ITS ON YOU! This command will print out the entries that will be removed and ask you if you really want to proceed. you have to input y or Y to proceed otherwise the log stays untouched.