BrainyLog

Your brain is pretty impressive! But sometimes it has trouble remembering things. BrainyLog is the extension to your brain, combining it's amazing cognitive abilities with a super-convenient tool that lets you access anything you wanted to remember, without having to remember the specifics of what you wanted to remember.

BrainyLog keeps track of any info you want to remember for posterity, be it specific research, or tasks that you don't want to leave un-completed.

And there's no need to be selfish. BrainyLog even allows you to share and collaborate memories - it's almost if you could share your brains (the memory part only, of course).

Sounds too good to be true? It is right now. Because we're in version v 0.1. But it won't be once it's given some time to mature.

Quickstart

You didn't master your mind in a few days. But you could get started the day you were born. BrainyLog works the same way, only faster.

BrainyLog commands run on the command line in your favorite Windows, Linux, or MacOS terminal: Before you can run any commands though, create an empty log.bl file in your current directory. BrainyLog will warn if this file does not exist in the current directory. This file is used to store all your logs, so be careful with it!

Add information:

$ brainylog a l The small bananas are my favorite.

The a command tells brainyLog to log some info. The l is an argument that tells brainyLog to add whatever comes after it to the logs.

Add tasks:

$ brainyLog a t l Bake a cake.
This works the same as the above command, except it adds a task "Bake a cake." The task is in the created state by default.

Retrieve information:

$ brainyLog g
This simply retrieves all the logs that haven't been deleted.

$ brainylog g l bake cake.
Bake a cake. [0]

The g command tells brainyLog to retrieve all lines that match some of the keywords that come after l. The lines are retrieved along with a number that can let you access the line directly using this number - more on this later.

You can use the nm argument to tell brainyLog not to display any metadata:

$ brainyLog g nm l cake Bake a cake.

You can also retrieve tasks in any given state:

$ brainyLog g t progress l bake cake

Also, given a line, you can get lines above and below it, including the line itself:

$ brainyLog g n 3 Each line displayed would have a new positional number, overwriting the previous number mappings.

If you want to keep the current number mapping, you can display these lines without the metadata:

$ brainyLog g n 3 nm

You can also process tasks, moving them to a different state:

$ brainyLog t t complete n 5

And retrieve tasks by state:

$ brainyLog g t progress

Or simply all tasks:

$ brainyLog g t allTasks

You can delete any logs entered by accident:

$ brainyLog d n 3

Find the complete documentation here:
https://github.com/thehamzarocks/brainylog/blob/master/doc.md

Local Setup

Want to fiddle around? Or give back? Get started with the source code on your own system:

A quick go tutorial:

https://howistart.org/posts/go/1/

Clone the repo

$ git clone https://github.com/thehamzarocks/brainylog.git

Install go for your env (look it up)

Set the environment for go commands

$ mkdir bin/

$ go env -w GOBIN=/some_path/bin

Build and install

$ go build

$ go install

Create a default log.bl file

$ touch log.bl

You're good to go!

$ ./brainyLog v
(add the binary to your path to call it without the ./)

thehamzarocks / brainylog