https://github.com/jsilvela/mediary

A tool to record events into a machine-readable format for eventual analysis.
https://github.com/jsilvela/mediary

Last synced: 7 days ago
JSON representation

A tool to record events into a machine-readable format for eventual analysis.

• Host: GitHub
• URL: https://github.com/jsilvela/mediary
• Owner: jsilvela
• License: mit
• Created: 2014-07-11T15:06:51.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-04-13T21:05:44.000Z (almost 8 years ago)
• Last Synced: 2024-11-11T02:41:59.841Z (2 months ago)
• Language: Go
• Size: 23.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Mediary

*Mediary* is a tool to write and store events into a machine-readable format.

## Installation

go get github.com/jsilvela/mediary


go build github.com/jsilvela/mediary

## Usage

	> mediary 

If no file is provided, mediary will create a new one, mediary.txt, in the

current directory.

Mediary reads from stdin and is line-oriented.

The syntax can be represented like so:



You start a new record by typing


```new {``` or ```new{```


and finish with ```}```

In the context of a record, you can specify the following fields:

* ```time: ``` with the time either "today", or in the format

"2014-01-30"

* ```tags: ``` accepting a comma-separated list

* ```text: ``` the program goes into text mode, which allows multi-line

text.

Outside of the context of an entry, each line is seen as a full and final

sentence, containing some filters, and a reporting directive.

* Filters: ```week```

* Reports: ```tags```, ```latest```

For example, a line could be: ```week latest```

To finish your session,


```exit``` or ```quit```

## Motivation

I've been keeping a notebook with health-related events, which has been pretty

useful. I want to transition it to files, but plain text means that any

reporting would be done with regex or similar. I'd like a good way to ask

questions, and I think a SQL db is too heavy-weight. Hence this project.

## Details

Concept version coded in *go* (this is my first Go program). Uses JSON for

storage.

Currently very much a CLI, but eventually would be nice to have this in a mobile

o.s.