/daybook

Markdown supported CLI journal.

Primary LanguageRubyMIT LicenseMIT

Daybook

Markdown supported CLI journal.

Usage

Writing an entry

daybook
> # Learning Go
> Today I wrote some Go. It was fun.
>
> ## Testing in Go
> I wrote a few tests. They were useful.
> ^D

1 daybook entry exists per day. Writing another entry on the same day will append it to the existing entry.

daybook
> # Learning Rust
> I had to stop, and got Rusty

> ## Compiling in Rust
> I compiled lots of Rust code.
> ^D

Viewing entries

ls entries

2024-07-07.md
cat 2024-07-07.md

# Learning Go
Today I wrote some Go. It was fun.

## Testing in Go
I wrote a few tests. They were useful.

# Learning Rust
I had to stop, and got Rusty

## Compiling in Rust
I compiled lots of Rust code.

Customization

Daybook.configure do |config|
  config.file_extension = "txt"             # Defaults to md
  config.entry_dir = "/path/to/somewhere"   # Defaults to entries
  config.date_format = "%m-%d-%Y"           # Defaults to %Y-%m-%d
end

Contributing

Setup

bin/setup

Running tests

bundle exec rspec

Checking test coverage

open coverage/index.html