tup - 일일 메모를 위한 쉘 도구

지난 몇 년 동안 저는 스탠드업 회의에 참여해 왔으며 매일 하는 일에 대해 메모할 수 있는 편리하고 효과적인 방법을 찾는 데 시간이 좀 걸렸습니다.

다음을 수행할 수 있어야 했습니다.

내가 작업한 문제, 내가 참여한 회의 및 내 작업을 방해한 항목에 대한 분류된 메모를 유지합니다

.

날짜를 기준으로 이러한 메모에 쉽게 액세스

예를 들어 지난 주에 내가 한 일에 대한 개요가 있습니다

.

위의 모든 것:

터미널 내부에서

메모를 찍은 날짜에 엄격하게 바인딩된 메모 포함

단일 문서를 수동으로 구조화하고 업데이트하지 않아도 됨

매일 수동으로 문서를 만들지 않아도 됨

그루터기

나는 실제로 bash 스크립트인 이 도구를 만들었고 stand-up이라는 용어에서 이름stup을 지정했습니다.



GitHub here에서 프로젝트를 찾을 수 있습니다.

사용 예

다음은 stup 의 가장 중요한 기능을 보여주는 몇 가지 예입니다.

메모 추가

# Adding a note to the default category at current date
stup add -n "Worked on issue #ABC123"

# Adding a note to the default category setting the current date explicitly
stup add today -n "Worked on issue #ABC123"

# Adding a note to the meetings category
stup add today -c "meetings" -n "2 hours with @phoebe for the project kick off"

# Adding a note to the blocking category for April 10th, 2020
stup add @ 2020-04-10 -c "blocking" -n "connectivity issues"

메모 표시

# 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"

일정 기간 동안 모든 메모 검색

# List current week's notes
stup log week

# List current week's notes skipping command's literal
stup week

# List previous week's notes
stup log previous-week

# List notes between January 20th, 2020 and March 2nd, 2020
stup log --from 2020-01-20 --to 2020-03-02

# List meeting notes between January 20th, 2020 and March 2nd, 2020
stup log --from 2020-01-20 --to 2020-03-02 -c "meetings"

무대 뒤에서

메모는 범주로 구성됩니다.

새 메모가 추가되면 stup는 마크다운 파일을 만들고 날짜를 기반으로 하는 경로가 있는 하위 디렉토리의 범주 디렉토리 아래에 배치합니다.

CATEGORIES_ROOT_DIRECTORY/CATEGORY/YEAR/MONTH/YYYY-MM-DD.md

# For example, the notes of a category named "programming" April 18th, 2020 are saved under
CATEGORIES_ROOT_DIRECTORY/programming/2020/04/2020-04-18.md

이를 통해 사용자는 특정 또는 모든 범주에 대해 특정 날짜 또는 특정 기간에 추가된 메모를 검색할 수 있습니다.

# 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

프로젝트repository에서 사용 예제가 포함된 전체 설명서와 프로젝트GitHub issues page에서 추가할 기능에 대한 자세한 정보를 찾을 수 있습니다.