https://github.com/mattmezza/todo

✅ A small todo utility for terminal lovers.
https://github.com/mattmezza/todo

bash dotfiles productivity script terminal todo utility

Last synced: 20 days ago
JSON representation

✅ A small todo utility for terminal lovers.

• Host: GitHub
• URL: https://github.com/mattmezza/todo
• Owner: mattmezza
• License: mit
• Created: 2019-11-17T17:52:17.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-27T18:30:29.000Z (over 4 years ago)
• Last Synced: 2024-11-02T23:22:27.637Z (2 months ago)
• Topics: bash, dotfiles, productivity, script, terminal, todo, utility
• Language: Shell
• Homepage:
• Size: 13.7 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
todo

===

`todo` is a utility for quickly keep track of your todos without leaving the comfort of your terminal.

![](todo.gif)

Installation

===

Installing `todo` is very easy: you just need to clone this very same repo at the latest release and then source the `todo.sh` file in your bash profile. Here's how I do it in my [dotfiles](https://github.com/mattmezza/dotfiles) (see plugins.sh and plugins.txt).

```bash

git clone --branch 1.0.0 [email protected]:mattmezza/todo.git && source todo/todo.sh 

```

Usage

===

What follows is the output of `todo help`, accessible at any time.

```

Usage:

  todo [CMD] [WHAT] [WHEN]

CMD can be:

  'add|a' to add element to list

  'remove|rm' to remove an element from a list

  'view|v' to print the list on stdout

  'left|l' to print the items left to do for WHEN

  'did' to print the items already did for WHEN

  'done|d' or undone|u to mark or unmark the item as done

  'carry-on|co' moves yesterday's undone items to today's list

  'push' moves today's undone items to tomorrow's list

  'help|h' prints this message

If no command is passed, 'view' is assumed.

WHEN can be:

  today|t

  tomorrow|tomo|tm

  yesterday|y

  week|w

  next-week|nw

  last-week|lw

  a temporal interaval referred to today's date (e.g. +2d, -2d etc...).

When CMD is 'view', it can also be a string matching the format '%Y-%m-%d' to list all the items in different days. If no WHEN is passed, 'today' is assumed.

Examples:

$ todo add 'Buy milk'

$ todo rm 'Buy milk'

$ todo view tomorrow

$ todo view 2019-11

$ todo view week

$ todo left today

$ todo did yesterday

$ todo done 'Buy milk' yesterday

$ todo undone|u 'Buy milk' yesterday

$ todo carry-on

$ todo push

```

#### Note on `week`

A week is to be intended from **Monday** to **Sunday**.

#### todo carry-on

This command takes all the items for yesterday that are not marked as done, and carries them over to today's todo list (I tend to ask too much from myself).

#### todo push

This command takes all the items for today that are not marked as done, and carries them over to tomorrow's todo list (I am a bloody procrastinator).

Development

===

Developing `todo` is quite easy. Clone the repo and start editing the `todo.sh` file. You can always source your verions and test it in your shell.