ToDonePy command-line interface (CLI)¶

Module contents¶

Command line interface for ToDonePy

Commands¶

to¶

Base command for managing tasks

Note: If you use a location other than the default for –file, I’d recommend setting TODO_FILE as an environemtal variable

to [OPTIONS] COMMAND [ARGS]...

Options

-f, --file <file>¶: Location of TODO.tsv

--version¶: Show the version and exit.

Environment variables

TODO_FILE: Provide a default for --file

do¶

Add some tasks to your list

rank: priority to assign to this task
tasks: Task(s) to be added to your list. Supports any number of arguments
Note: All tasks will be added at the same rank
Note: –sort defaults to “both”. If must be one of :

[“rank”, “date”, “both”, “none”]. If none, tasks are not resorted after additions

Note: If your task is more than 1 word long, enclose it in quotes
Note: A timestamp of the form %y-%m-%d %H:%M:%S is also added

to do [OPTIONS] RANK TASKS...

Options

-s, --sort <sort>¶: How to sort added tasks

Arguments

RANK¶: Required argument

TASKS¶: Required argument(s)

doing¶

See tasks in your list

Note: –sort defaults to “none” to preserve order in file.

It must be one of [“rank”, “date”, “both”, “none”].

Note: –sort calls before –graphic or –editor
Note: –graphic has a dependency on notify-send and is Linux/Mac Specific
Note: –no-edit is default, so does not need to be specified for calls where you do NOT want an editor.

to doing [OPTIONS]

Options

-s, --sort <sort>¶: How to sort returned tasks

-n, --number <number>¶: How many tasks to return

-g, --graphic, -G, --no-graphic¶: Send a graphic remider instead of echoing to the terminal

-e, --edit, -E, --no-edit¶: Open TODO.tsv in your editor

done¶

Remove a task to your list

tasks: Task(s) to be added to your list. Supports any number of arguments
Note: If multiple lines match an of the tasks, they will all be deleted.
Note: If your task is more than 1 word long, enclose it in quotes
Note: If a task is not found, then the CLI will say so

to done [OPTIONS] TASKS...

Arguments

TASKS¶: Required argument(s)