Journal

Teste de software group members:

• Arthur Codama
• Gabriel Marques
• Gabriela Ciríaco
• Matheus Marques
• Victor Hugo Magalhães

Journal is a command line journal heavily inspired by journal-cli. It aims to keep all your entries in an easy to read and manipulate file, allowing you to take notes and consulting them later. Entries saved on the journal are logged in the following way when read:

Date: 26/02/2022
  Hash: 2705810935
  Message: Why did you choose this day as an example? It is an ordinary day nothing special happened this day.

Usage

To create an entry simply type:

journal add "Today I waste 15 minutes thinking in an entry example, :("

The entry will be saved as readable text in the cli installation folder. Entries that don't specifies a date will be saved as "today". You can also specify a date using the add command:

journal add 14/2/2022 "Oh my god, I totally forgot to write about how normal 14/2/2022 was!"

journal add 26-02-2022 "In this day I thought that allowing people do use dashs as date separator may be a good idea!"

The add command also supports some special cases:

journal add today "I'm not thirsty at all today."

journal add yesterday "Wow, I drank a lot of water yesterday, in fact, I drank so much that I didn't had time to write an entry."

You can add as many entries per day as you want. When you try to read them the journal will log in the order they were wrote.

To read an entry, you must use the read command, I works pretty similar to the add command, so if you do not specify a date it will read the "today" entry:

journal read

You can also specify a date to consult:

journal read 14/2/2022

The read command also supports some special cases:

journal read today

journal read yesterday

You can also delete entries using the delete command, it follows the same principle as the other two flags, so if you do not specify a date the today entry will be deleted:

⚠️ Be aware: Deleting is a permanent action, the deleted entries will be gone forever!

journal delete

You can also specify a date to delete:

journal delete 14/2/2022

The delete command also supports some special cases:

journal delete today

journal delete yesterday

Be aware that the delete command using days as filter will erase all the data from the selected day. The way to erase only a specific entry is to use the delete command passing the Hash of the entry:

journal delete 2705810935

You can also clean all your entries using the purge command, it does not accepts any parameter or flags and clean all your entries.

⚠️ Be aware: Purging your journal is irreversible and you will not be able to retrieve your entries anymore!

journal purge

Last but not least, you can also read all your entries using the dump command, it does not accepts any parameter or flags and outputs all your entries.

journal dump

Build

journal is built in go, and can be built for your machine using:

make build

Technologies

The journal is built using golang 1.16.3 (but is compatible with any version since 1.13). It uses Cobra as the CLI framework and Go YAML as yaml parser. It also has its build automatizaded with Make, refer to the Build session to learn how to build it.

Credits

The journal logo was made using Freepik flaticon free icons: Journal icons created by Freepik - Flaticon