Go to file
Arthur POULET 48acd667a7
Update version
2017-04-12 21:55:25 +01:00
spec Init project 2017-03-21 16:07:37 +00:00
src Change JSON to YAML 2017-04-12 21:48:56 +01:00
.gitignore Fix gitignore 2017-03-21 18:13:14 +00:00
.travis.yml Init project 2017-03-21 16:07:37 +00:00
LICENSE Init project 2017-03-21 16:07:37 +00:00
Makefile Init project 2017-03-21 16:07:37 +00:00
README.md Update README 2017-04-12 19:21:54 +01:00
shard.yml Update version 2017-04-12 21:55:25 +01:00

README.md

todo

track your todo lists in your terminal

Installation

make

Usage

todo # list the tasks
todo -l listX # list (-l = list selection) the tasks of a list
todo --rm ID # remove a task
todo --date DATE an example of content for a task # add a new task

Usage: todo [arguments]
    -a=ID, --archive=ID              Move to archive
    -u=ID, --update=ID               Update the task ID
    -r=ID, --remove=ID               Delete the task ID
    -l=NAME, --list=NAME             Filter with the list NAME
    -d=DATE, --date=DATE             Set the date
    -s, --sort                       Sort by date (by default)
    -i, --sort-id                    Sort by id
    --clear-all                      Remove everything in the list
    -h, --help                       Show this help

Date parsing

There are several type of date format which are parsed automatically:

  • [Y]/<M>/<D>: classic date format
  • D+<n>: where n is the amount of days before the task ends

Configuration

Hooks

You can set some hooks, which will be executed. Write a yaml file ~/.config/todorc with the following structure:

hooks:
  before_load:
    - some command to execute
    - an other command
  after_load:
  before_add:
  after_add:
  before_list:
  after_list:
  before_rm:
  after_rm:
  before_update:
  after_update:
  before_archive:
  after_archive:
  before_clear_all:
  after_clear_all:
  before_save:
  after_save:

Development

TODO: Write development instructions here

Contributing

  1. Fork it ( https://github.com/Nephos/todo/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

  • Nephos Arthur Poulet - creator, maintainer