Skip to content

49pctber/rapidlog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rapid Log

A simple command-line tool to create a digital rapid log.

About

A rapid log is an efficient way to record notes, to-dos, events, feelings, and questions. Each entry is prepended with one of five symbols according to the following table:

Symbol Description
- notes, thoughts, etc.
. to-do list items
o events
= feelings, mindfullness
? questions

Installation

You can install rapidlog using the command

go install github.com/rapidlog/rapidlog@latest

Usage

Open a terminal and type rapidlog and press enter. Type the character corresponding to the entry type you would like to create, and type your entry. Note that you can input multiple entries at once. When you're done, simply type exit or quit.

For example:

rapidlog
- wrote a book today
= ecstatic that I'm done
o broke my leg at the gym
. get cast on leg
? how long will my leg take to heal?
quit

Reading Your Entries

You can list all of your entries using rapidlog list. This will list your entries and group them by date. For more information, you can append the -v flag to enable verbose printing. This will give a timestamp and the entry's ID (e.g. so you can delete entries later if necessary).

If you only want to list certain items (e.g. to-do items prepened with ., or questions prepended with ?), use the command rapidlog list -e ..

Alternatively, you can call rapidlog summary which will render all of your entries as HTML. Your default browser will be opened to display your rapid log.

Editing an Entry

You can edit your entries in your default text editor by runing rapidlog edit <id>. (A typical entry ID looks like 2hCcN9LzWH0whbkF8vzSSdKCVfA.) Edit your entry like you would any other text file, save, and close your editor. The saved version of your entry will replace your old entry.

Deleting an Entry

You can delete an entry using the comand rapidlog delete <id>, where ID can be obtained by either

  1. reading the ID from using rapidlog list -v
  2. clicking on the entry from summary.html to copy it to your keyboard

Syncing Databases File

If you have multiple database files (e.g. you use rapidlog on multiple computers), you can export your databases using rapidlog export <path> to copy your database file to somewhere on your computer. You can then import it using rapidlog import <path> on your other machine.

--help

If you want more information about how to use this program, run rapidlog --help in your terminal.

Packages

No packages published

Languages