Skip to content

ariadnavigo/dream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

dream - Quick diary entries generator

This is a small tool written in POSIX shell that creates text files with the current date as their filename. This is designed to quickly generate entries in a diary(-like) database stored in the filesystem. It proceeds to open the default editor with the newly created entry file.

Usage

$ dream [-f FILENAME] [-t TITLE] [-x EXTENSION] DIR

dream requires pointing to a directory $DIR where entries are being stored. Be aware that dream will block creating a filename for a date if there's already one. This program doesn't do any management of files apart from creating them.

Unless otherwise specified with option -f, the newly created file will be named YYYY-MM-DD.md, defaulting to Markdown formatting. Be aware that -f only changes the name before the file extension; to change the file extension, use -x (without the dot; e.g., -x txt to create a .txt file).

The title (or first-level header) in the file will also default to YYYY-MM-DD, but you may override this by using the option -t.

Trivia

The name dream is due to me originally using this to write down my dreams the morning after (when I remember them).

License

dream is licensed under the MIT License. See LICENSE file for copyright and license details.

About

Quick diary entries generator

Topics

Resources

License

Stars

Watchers

Forks

Languages