special-octo-robot 0.2.0

Creating my own version of what a CLI Task manager and To-do-list would look like

Devcord

Devcord is a CLI tool designed to help you quickly manage your tasks as well as help you monitor your time usage. Along with all the essential to-do list functionalities, Devcord allows you to select a task and start a session on it.

During a session, your time-spent on each of your activity is monitored for you to view later. This is useful for people who want to find out where their time is spent.

None of the data is stored on any server, it is all stored locally on your machine.

Installation

With pip:

pip install --upgrade devcord

Post Installation

To avoid typing devcord repetitively, register an alias in your shell configuration file.

For bash:

alias tasks="devcord tasks"
alias task="devcord task"

Usage

For adding tasks

Simple add task:

$ devcord tasks -a "task name"
$ devcord tasks --add "task name"

With description:

$ devcord tasks -a "task name" -d
$ devcord tasks --add "task name" --desc

Opens scrollable text box to enter description

With due date:

$ devcord tasks -a "task name" -dd "dd/mm/yyyy"
$ devcord tasks --add "task name" --due "dd/mm/yyyy"

Complete by today:

$ devcord tasks -a "task name" -t
$ devcord tasks --add "task name" --today

Complete in current week:

$ devcord tasks -a "task name" -w
$ devcord tasks --add "task name" --week

With priority (1-5):

$ devcord tasks -a "task name" -p 3
$ devcord tasks --add "task name" --priority 3

With labels:

$ devcord tasks -a "task name" -lb "label"
$ devcord tasks --add "task name" --label "label"

Add subtask:

$ devcord tasks -a "task name" -st
$ devcord tasks --add "task name" --subtask

For listing tasks

By default, in-progress and pending tasks are listed, with in-progress first followed by pending tasks and completed tasks are skipped.

Simple List tasks:

$ devcord tasks -l
$ devcord tasks --list

With subtasks:

$ devcord tasks -l -st
$ devcord tasks --list --subtasks

List tasks by priority:

$ devcord tasks -l -p 3
$ devcord tasks --list --priority 3

List tasks by label:

$ devcord tasks -l -lb "label"
$ devcord tasks --list --label "label"

List today's tasks:

$ devcord tasks -l -t
$ devcord tasks --list --today

List tasks due in current week:

$ devcord tasks -l -w
$ devcord tasks --list --week

List tasks by status:

$ devcord tasks -l -i
$ devcord tasks --list --completed
$ devcord tasks -l --pending

Specify Output Format:

$ devcord tasks -l -o json
$ devcord tasks --list --output text

Specify Output File:

$ devcord tasks -l --path "path/to/file"

For managing tasks

Pass the keyword to perform required action on the task. The command will then prompt you through a fuzzy finder to enter the task title. The keyword action would be performed on the selected task.

Viewing description:

$ devcord task -d
$ devcord task --desc

Opens a scrollable text box with description

Show substasks:

$ devcord task -st
$ devcord task --subtasks

Mark as inprogress:

$ devcord task -i
$ devcord task --inprogress

Mark as complete:

$ devcord task -c
$ devcord task --completed

Mark as pending:

$ devcord task -pd
$ devcord task --pending

Set deadline to this week:

$ devcord task -w
$ devcord task --week

Set deadline to today:

$ devcord task -t
$ devcord task --today

Delete Task:

$ devcord task -dl
$ devcord task --delete

Modify Title:

$ devcord task -n "new title"
$ devcord task --name "new title"

Modify Priority:

$ devcord task -p 3
$ devcord task --priority 3

Modify Deadline:

$ devcord task -dd "dd/mm/yyyy"
$ devcord task --deadline "dd/mm/yyyy"

Modify Labels:

$ devcord task -lb "label"
$ devcord task --label "label"

Modify Completed Task:

$ devcord task -ar -n "new title"
$ devcord task --archive --name "new title"

Jira Integration

With Jira integration you can view all your issues on devcord itself and sync them as when required with a single command. On your first use instead of the following commands, you'd be asked to set up your configuration for Jira.

Sync with Jira

$ devcord jira --sync

Set Organization URL

$ devcord jira --url

Set Organization Email

$ devcord jira --email

Set Jira Access token

$ devcord jira --token

Miscellaneous

Update Database Schema:

$ devcord init --migrate

This updates the database schema if any changes were made

Use Rich Tree:

$ devcord init --pretty_tree False

Use Pretty Tree:

$ devcord init --pretty_tree True