daily-notes

Daily notes is a CLI tool for generating note files based on templates and can preserve items day over day.
Report Bug · Request Feature

About The Project

Daily notes allow you to maintain a customized template in Markdown to generate your note files and allow you to preserve items from the previous day.

For example:

The base template will include a Tasks section:

Tasks

• Task 1
• Task 2

When you preseve with the -p flag, any unchecked tasks will be brought to the next day.

Any line prefixed with a -p in the note will also be preserved.

For example:

- item 1
-p preserved item 3
- item 3

(back to top)

Built With

• Cobra CLI

Getting Started

To get started you will need the following installed on your system:

Prerequisites

• Go

Installation

1. Clone the repo

   git clone https://github.com/BrandenM-OW/daily-notes.git
   

2. Build the project

   cd path/to/repo/
   go build main.go
   

3. Add the binary to your system path if you so choose.

4. Binary downloads to come so no build will be required.

(back to top)

Usage

init

daily-notes init

Creates the following directory structure:

root/
├── config.yaml
├── notes
│  └── month
│    └── week
│      └── day.md
└── templates
	└── daily.md

New

daily-notes new
daily-notes new -p // Preserves notes from last day
daily-notes new -d 1 // Creates a note for tomorrow

Adds the following file:

root/
└── notes
    └── month
        └── week
            └── day.md

The day.md file will be created based on the template specified in the config.yaml file.

If the preserve flag is set, the last day.md file will be used as a template for the new day.md file. - All unchecked tasks will be copied over - All notes will be copied over that are not marked with the -p flag

(back to top)

Roadmap

• Adding binary downloads to repo.
• Template flag to use other templates.
• Better preseve flag options to allow you to pick a day to preseve from.

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)