Your Web News in One Place

Help Webnuz

Referal links:

Sign up for GreenGeeks web hosting
April 30, 2020 08:11 pm GMT

stup - a shell tool for daily notes

Over the past few years I've been participating in Stand-up meetings and it took me some time to find a convenient and effective way for keeping notes about what I was doing every day.

I needed to be able to:

  • keep categorized notes on the issues I worked on, the meetings I participated in and stuff that blocked my work etc
  • easily access these notes based on their date
  • have an overview of what I did for example the last week
  • all of the above:
    • from inside a terminal
    • with the notes strictly bound to the date they are taken
    • without having to manually structure and update a single document
    • without having to manually create a document for each day

stup

I made this tool which actually is a bash script and I named it stup from the term stand-up.

stup demo

You can find the project on GitHub here.

Usage examples

Below are some examples showing the most important features of stup.

Adding notes

# Adding a note to the default category at current datestup add -n "Worked on issue #ABC123"# Adding a note to the default category setting the current date explicitlystup add today -n "Worked on issue #ABC123"# Adding a note to the meetings categorystup add today -c "meetings" -n "2 hours with @phoebe for the project kick off"# Adding a note to the blocking category for April 10th, 2020stup add @ 2020-04-10 -c "blocking" -n "connectivity issues"

Showing notes

# Showing yesterday's notes$ stup# Showing yesterday's notes explicitly setting the date$ stup yesterday# Showing today's notes$ stup today# Showing notes on a specific date$ stup show @ 2020-04-18# Showing notes on a specific date for the meetings category$ stup show @ 2020-04-18 -c "meetings"

Retrieving all notes for a period of time

# List current week's notesstup log week# List current week's notes skipping command's literalstup week# List previous week's notesstup log previous-week# List notes between January 20th, 2020 and March 2nd, 2020stup log --from 2020-01-20 --to 2020-03-02# List meeting notes between January 20th, 2020 and March 2nd, 2020stup log --from 2020-01-20 --to 2020-03-02 -c "meetings"

Behind the scenes

Notes are organized in categories.

When a new note is added, stup creates a markdown file and places it under the category's directory in a sub-directory with a path based on the date.

CATEGORIES_ROOT_DIRECTORY/CATEGORY/YEAR/MONTH/YYYY-MM-DD.md# For example, the notes of a category named "programming" April 18th, 2020 are saved underCATEGORIES_ROOT_DIRECTORY/programming/2020/04/2020-04-18.md

This allows users to retrieve any notes added on a specific date or in a specific period for a specific or for all categories.

# Fetch notes for all categories$ stup show @ 2020-04-18# Fetch notes for a specific category for previous week$ stup log previous-week -c programming# Fetch notes for all categories for a specific period$ stup log --from 2020-04-01 --to 2020-04-15

You can find the full documentation with usage examples on the project's repository and more information about features to be added in the project's GitHub issues page.


Original Link: https://dev.to/iridakos/stup-a-cli-tool-for-daily-notes-503f

Share this article:    Share on Facebook
View Full Article

Dev To

An online community for sharing and discovering great ideas, having debates, and making friends

More About this Source Visit Dev To