geekaholic / ii.do

A simple bash todo script which uses Markdown syntax

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

About ii.do

ii.do, pronounced I-do (as in "Do you solemnly swear to complete all tasks till death do us part?" :-), is a simple bash script which can be used to keep track of a todo list.

After being inspired by the simplicity of Markdown syntax and Todo.txt, a commandline todo script, I decided to write my own script that combined both aspects.

The result is a simple todo.markdown file which you can easily create in your home directory and edit using any text editor (though I recommend one which has syntax highlighting such as VIM).

What's New (0.8.x)

Improvements to HTML outputted version (using -H flag) includes:

  • Click on a heading or task to edit it inline in the browser
  • Sort tasks within it's task heading by dragging it
  • Tick the checkbox to mark the completion of a task
  • Changes are automatically saved to local storage
  • Indicate if what is showing on the HTML page is from local storage
  • Clear local storage by clicking on the indicator to revert to content of HTML page

Getting Started

  1. Create an empty todo.markdown file in your UNIX home directory or use my sample file.

  2. When editing the file, use the following format.

# Top level heading

* Task 1
* Task 2
* etc.

## Sub heading

* Sub Task 1
* Sub Task 2
* etc.
  1. Mark a task as completed by preceding it with a 'x'
* x Task 1 is complete
  1. Mark a task as important by preceding it with a '!'
* ! Task 1 is very important
  1. Define a priority as either a letter or number in front of task
* (1) Do Task 1 first
* (2) Then do Task 2
  1. Set a due date for a task by ending with "by mm/dd/yyyy"
* Task 1 by 12/31/2013

  1. To view tasks from anywhere define an alias in your ~/.bash_profile or ~/.bashrc
alias t='~/Downloads/ii.do/ii.do'
  1. To use a different todo file use the -f option with full path to the file.
alias t='~/Downloads/ii.do/ii.do -f ~/Dropbox/todo.md'
  1. To quickly launch the editor (vi by default, else $EDITOR) and edit the todo file
t -e
  1. Get a count of pending tasks
t -n
  1. Change Shell prompt to always show number of pending taks
t -S "$PS1" >> ~/.bash_profile
  1. Export iido list as a self contained HTML file to email or track task completion locally
t -H > iido.html

For a complete set of options do t-h

See Also

My blog post with an embedded talk on ii.do

License

Copyright © 2018 Buddhika Siddhisena

Licensed under WTFPL

About

A simple bash todo script which uses Markdown syntax

License:Do What The F*ck You Want To Public License


Languages

Language:Shell 100.0%