Skip to content
/ j Public

small journaling tool for a fast workflow

Notifications You must be signed in to change notification settings

refs/j

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Codacy Badge

J - A Hacker Journaling Companion written in Go

Just a friendly hacker companion

Usage

$ go install github.com/refs/j
$ j

that's it.

Gotchas

It currently supports only VIM.

Roadmap

  • support for version control
  • support encrypted entries
  • configuration

User Journey v0

  1. $ j
  2. j creates a file in J/HOME and opens the user editor (if no editor is provided in config)
  3. start journaling
  4. when saving the file, j commits it to your configured repository (if any)

One of the premises is that editing will only happen for the current entry, this tool will not update older entries.

Features

  • throw in some encryption to your pages

  • add some configuration

    • home folder

    • version control

    • distributed storage (integration with distributed database?)

    • editor config option

    • github integration

    • extract H1 from file and append it to the filename

    • if there is already a file with today's date, start the editor in append mode

    • while listing files, dynamically select one for opening

    • make template contents configurable

    • query entries

  • bootstrap (rails like)

  • configurable file structure

About

small journaling tool for a fast workflow

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •