Skip to content

timerdo

Timerdo is a minimalist to-do list with built-in timer to keep your tasks on track.

Usage:

$ timerdo [OPTIONS] COMMAND [ARGS]...

Options:

  • -v, --version: Print version.
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • delete: Delete item, given table and item id.
  • edit: Edit task or timer entries.
  • query: Query the data with sql script and return...
  • report: Print reports.
  • start: Start timer.
  • stop: Stop running timer.
  • task: Add a task to the To-Do list.

timerdo delete

Delete item, given table and item id.

Usage:

$ timerdo delete [OPTIONS] TABLE:{task|timer} ID

Arguments:

  • TABLE:{task|timer}: Table containing the item. [required]
  • ID: Item id. [required]

Options:

  • --help: Show this message and exit.

timerdo edit

Edit task or timer entries.

Usage:

$ timerdo edit [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • task: Edit a task item.
  • timer: Edit a timer item.

timerdo edit task

Edit a task item.

Usage:

$ timerdo edit task [OPTIONS] ID

Arguments:

  • ID: Item id. [required]

Options:

  • -t, --task TEXT: Task
  • --tag TEXT: Task tag.
  • -d, --deadline [%Y-%m-%d]: Task Deadline.
  • -s, --status [To Do|Doing|Done]: Task Status.
  • --help: Show this message and exit.

timerdo edit timer

Edit a timer item.

Usage:

$ timerdo edit timer [OPTIONS] ID

Arguments:

  • ID: Item id. [required]

Options:

  • -c, --create_at [%Y-%m-%d %H:%M:%S]: timer start.
  • -f, --finished_at [%Y-%m-%d %H:%M:%S]: timer stop.
  • --help: Show this message and exit.

timerdo query

Query the data with sql script and return a json.

Usage:

$ timerdo query [OPTIONS] SCRIPT

Arguments:

  • SCRIPT: sql script. [required]

Options:

  • --help: Show this message and exit.

timerdo report

Print reports.

Usage:

$ timerdo report [OPTIONS]

Options:

  • -d, --done: Return also tasks with Done status.
  • -t, --tag TEXT: Filter tags.
  • -i, --init [%Y-%m-%d]: Timeframe's lower boundary.
  • -e, --end [%Y-%m-%d]: Timeframe's upper boundary.
  • -o, --order-by TEXT: Column to order by.
  • -a, --asc: If ordered by it will be in ascending order.
  • --help: Show this message and exit.

timerdo start

Start timer.

Usage:

$ timerdo start [OPTIONS] TASK_ID

Arguments:

  • TASK_ID: task id for timing. [required]

Options:

  • --help: Show this message and exit.

timerdo stop

Stop running timer.

Usage:

$ timerdo stop [OPTIONS]

Options:

  • -d, --done: Set the task to Done. [required]
  • --help: Show this message and exit.

timerdo task

Add a task to the To-Do list.

Usage:

$ timerdo task [OPTIONS] TASK

Arguments:

  • TASK: Task to be add to To-Do list. [required]

Options:

  • -t, --tag TEXT: Task tag.
  • -d, --deadline [%Y-%m-%d]: Task Deadline.
  • -s, --status [To Do|Doing|Done]: Task Status. [default: To Do]
  • --help: Show this message and exit.