Skip to content

Latest commit

 

History

9 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

journal

CLI journal application for tracking daily entries with timestamps. Inspired by Zed's journal feature.

Installation

build from source

git clone https://github.com/halqme/journal.git
cd journal/cmd/journal
go install .

Usage

# Direct input
journal "今日の振り返り"

# Open editor ($EDITOR)
journal

# Open editor (explicit)
journal -e

# Project mode (create .journal/ in current directory)
journal -p "プロジェクト用メモ"

# Print entries directory (for fzf etc)
journal --root

fzf Integration

# Browse and open entries
vim "$(find $(journal --root) -name '*.md' | fzf)"

# With project mode
vim "$(find $(journal -p --root) -name '*.md' | fzf)"

Settings

~/.journal/settings.json

{
  "hour_format": "24",
  "path": "~/.journal/entries",
  "editor": "",
  "template": "# {time}\n",
  "default_project": false,
  "file_name_format": "02.md",
  "auto_create_settings": true
}

Options

Key Description Default
hour_format Time format for headings "24" (or "12")
path Base directory for entries "~/.journal/entries"
editor Override $EDITOR env var "" (use env)
template Entry header template. {time} is replaced with the time value "# {time}\n"
default_project Create entries in current directory by default false
file_name_format Entry filename format (Go time format) "02.md"
auto_create_settings Auto-generate settings file on first run true

Template Examples

// Default
"template": "# {time}\n"
// → # 09:55

About

zed's inspired journaling tool

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages