#Command line TODO-Lists. [NEW] Gamified Todo-lists. Plus Firebase Support for syncing.

Manage your todos from command line.

Current Version is 0.5beta1 called "Scrub-Jay".

RoadMap

Features (DONE)

• Add Todos + bounty
• Get All Todos
• Get Todos by name
• Mark the todos done.
• Command line coloring.
• Tags
• Filters
• Rewards.
• Due Dates/ times.
• Folders/Project Categorization.
• Snooze by Edit.
• time-logging.
• Snoozes.
• timers.
• User Dashboard in command line.
• dynamic folders.
• Offline Support
• Move to Python3
• Wiki Help.

Features(WIP) coming with 0.5beta2 "Dove"

• Testing.
• Quadrant System for Task Management
• Task Search.

Features (Cold Storage) on road for 0.5beta3 "Verdin"

• Assigning to the other people.
• Team project Management.
• User Accounts
• Team Accounts.

##Usage

This part of document is for main commands in the cmd-todo Suite.

1.Add a Todo/ Reward.

Adding a todo/task or Reward.

• Quick Add ( fast add via command line.)

--add/-a with 2 args, task and bounty

python todo.py -a/--add [task] [bounty]

Note: Quick Add still doesn't support due dates, tags and folders. [In works.]

• Add with a flow (Series of Questions like task, bounty etc.)

--add/-a with no argument

python todo.py -a/--add

Will end up in resonsive addflow.

• Add a reward

--add/-a with 2 args then with --reward/-r argument

python todo.py -a/--add [reward][bounty] -r/--reward

2.Print tasks/ rewards

How to go about printing/getting task, by tag, by folders etc.

• Print All Tasks.

--get/-g with no arguments.

python todo.py -g/--get

Format of the Output: Output of all get commands is displayed in certain way so you get to the todo you want fast. Basic format is like this:

[name]:[bounty]:[task][optional tick sign]

name: this and crucial and important field, this is unique to each task. This is field that you can use to communicate to the system about which task are you talking about. System ensures that its easy to type.

bounty: This is heart and soul of our gamified todo listing app. You can assign different bounty to each task to convey its importance/ or its rewards.[Priority lists are in development.]

task: string describing what needs to be done.

optional tick sign: appears only to indicate if something is completed or not.

example:

todo395 : 90 : Coffee With Lara

name = todo395
bounty = 90
task = Coffee with Lara

• Print tasks by name.

--get/-g with one argument that is name of the todo.

python todo.py -g/--get task_name

• Print tasks by tags.

--get/-g with --tag/-t with one or more arguments.

python todo.py -g/--get -t/--tag tag [tag...]

Note: atleast one argument must be specified to for above to filter by tag.

• Print tasks by folder.

--get/-g with --folder/-f with one argument that is foldername

python todo.py -g/--get -f/--folder foldername

• Print tasks filtered by both folder and tags.

--get/-g with --folder/-f with one argument that is the foldername, and --tag/-t with one or more arguments which are filtering tags.

python todo.py -g/--get -f/--folder foldername -t/--tag tag [tag...]

• Print All Rewards.

--get/-g with --reward/-r

python todo.py -g/--get -r/--reward

Format of the Reward Output: Output of all get commands is displayed in certain way so you get to the todo you want fast. Basic format is like this:

[name]:[bounty_req]:[reward]->[Redeemed n times]

name: unique name for each reward. this is how the system knows about this rewards' existense.

bounty_req: Minimum bounty required to redeem this reward.

reward: text describing the reward.

redeemed times: indicates how many times this particular reward has been redeemed in the past.

example:

rw367 : 5 : 15 mins break -> redeemed 5 times

name = rw367
bounty_req = 5
reward = 15 mins break
redeemed_times = redeemed 5 times

• Print Reward by name.

--get/-g with --reward/-r with reward_name argument.

python todo.py -g/--get -r/--reward reward_name

3. Editing Todos.

• Edit a todo

--edit/-e with one argument that is the name of the todo to be edited.

python todo.py -e/--edit name

• Move to different folder

--edit/-e with one argument that is the name of the todo to be edited and --folder/-f with one argument that is the name of the destination folder.

python todo.py -e/--edit name -f/--folder foldername

4. Snoozing a Task.

--snooze with two argument, first is the todo name and second one is the snooze string(due time String).

python todo.py --snooze name duetime_string

Duetime Strings: They form an integral part of how we represent due times in more human ways in our system. like you can write "+9h" as duetime_string if something is due in 9 hours. or you can use combination of duetime strings to represent more complex due time, like for example, "+3w-2d+7h-20M" means 3 weeks ahead, then 2 days behind, then 7 hours ahead, and finally -20 minutes behind. We also accept dates so you don't have to calculate time delta if you already have the due dates.

• Duetime string should either be a date string of the format "YYYY-mm-dd"(eg. 2015-07-05) or our own duetime strings like "+9h" or "+60M"
• Duetime string should either start with "+" or "-". "+" stands for ahead in time and "-" stands for behind in time.
• eg. duetimestring should have final time_classifier like "h", "m" etc to signify units of time.
• Acccepted time Units are:
  • M - minutes.
  • h - hours.
  • d - days
  • w - weeks (7 days)
  • m - months (30 days)
  • y - years (365 days)

5. Deleting a todo/ reward/ folder.

NOTE: Delete doesn't have short flag like "-d"("-d" is actually for marking something done.), Since delete is considered a dangerous operation. You can't get back anything that is deleted.

1. Deleting todos. (one or many)

--delete with one or more arguments that are names of todos to be deleted.

python todo.py --delete todo [todo...]

2. Deleting rewards( one or many)

--delete with one or more arguments that are name of rewards to be deleted, with --reward/-r command.

python todo.py --delete reward [reward...] -r/--reward

3. Deleteting a folder.

--delete wth one argument that is the name of the folder to be deleted, with --folder/-f command.

python todo.py --delete foldername -f/--folder

NOTE: You can't delete multiple folders in delete a folder command, and that is by design.

6. Marking a todo done.

-d/--done command with one or more arguments that are name of the todos that are to be marked done.

python todo.py -d/--done todo [todo...]

(* Done and delete command is also in works.)

7. Redeeming a Reward.

--redeem/-x command with one argument that is the name of the reward and second is optional times argument.

python todo -x/--redeem reward [times]

• By Default times will be 1. This "times" field is important to take smaller rewards multiple times, for eg. "15 minutes break" reward redeemed 3 times is actually 45 minutes break.

8. User Profile/Dashboard

• Viewing Dashboard/Profile

--me/-m command to view your profile/dashboard

python todo.py -m/--me

• Updating Email and Name.( And other info in future)

--me/-m command with --editinfo command.

python todo.py -m/--me --editinfo

9. Schedule

• Viewing your Schedule, which is equivalent to dividing your tasks into folders like "Today", "Tommorrow", "Next Week" etc.

--schedule command with no arguments.

python todo.py --schedule

10. Timers.

Timers are an important feature since we wanted to do timelogging within a project/task management app. Many apps don't do this, but its most natural for the timelogging to be in a todo app.

Timer commands are nested in edit commands since they somehow change some data associated with todos they run on.

• Start a timer for todo

--edit with one argument that is the name of the todo on which timer should run, with --timer command.

python todo.py --edit todo --timer

how to stop a timer?: with Ctrl+C.(or Cmd+C in mac) NOTE: the above command behaves like a pause/play button, if todo already has time associated with it, timer will start from there. If you however want to start timer from zero even though todo has time associated with it, then look for "Reset and start timer for todo" commands introduced below.

• Reset the timer for the todo.

--edit with one argument that is the name of the todo, with --resertcommand. It will put todo's timer to 0:00:00.

python todo.py --edit todo --reset

• Start and Reset timer for todos.

If the todo has time associated with it, this command with change that to zero and run from the start.

--edit with one argument that is the name of the todo, with --timer and --reset commands.

python todo.py --edit todo --timer --reset

11. Version Checking.

To check with version of the software you're using, supply -V or --version to the software.

python todo.py -V/--version

12. Syncing to Firebase.

cmd-todo comes with inbuilt firebase support. To sync to firebase, use --sync command.

python todo.py --sync

NOTE: There are lot more features coming and somedays we will move most of this help somewhere else.