studycli

A CLI tool to create study tasks and revision strategy for learnings. Revisions are added for <1, 3, 7, 30, 90, 180, 360> days once a learning is completed. Revision strategy days can be customized using STUDY_REVISION_DAYS environment variable for eg., setting STUDY_REVISION_DAYS="1,10,100" will creating revision tasks for 1st, 10th and 100th days after completing a learning.

• Usage
• Commands

Usage

$ npm install -g studycli
$ study COMMAND
running command...
$ study (-v|--version|version)
studycli/0.2.0 darwin-x64 node-v8.11.1
$ study --help [COMMAND]
USAGE
  $ study COMMAND
...

Commands

• study add
• study help [COMMAND]
• study list
• study remove
• study update

study add

Adds a new study task

USAGE
  $ study add

OPTIONS
  -c, --completed
  -d, --datetime=datetime  [default: 02/02/2020 00:00]
  -l, --learning
  -r, --remarks=remarks

DESCRIPTION
  for eg. study add 'Read read read!'
     -l, --learning   Marks the task as a learning which needs revision
     -c, --completed  Marks the task as completed
     -d, --datetime   Date/time (DD/MM/YYYY HH:mm) for the task to be completed
                      Default is today
                      Or +NumberOfDays; -t +9 -> add a task to a date i.e,today + 9 days

See code: src/commands/add.js

study help [COMMAND]

display help for study

USAGE
  $ study help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

study list

List the tasks for the day.

USAGE
  $ study list

OPTIONS
  -a, --[no-]all
  -c, --[no-]completed
  -d, --datetime=datetime  [default: 02/02/2020]
  -l, --[no-]learning
  -r, --[no-]revision

DESCRIPTION
  ...
  By default list the tasks for the day.
     -d, --date       Lists the tasks for the day
     -c, --completed  Lists the tasks by completed status
     -l, --learning   Lists learning tasks
     -r, --revision   Lists revision tasks

See code: src/commands/list.js

study remove

Removes the tasks.

USAGE
  $ study remove

DESCRIPTION
  Task ids should be passed as arguments. 
     for eg: study remove task-id1 task-id2

See code: src/commands/remove.js

study update

Updates the task.

USAGE
  $ study update

OPTIONS
  -c, --[no-]completed
  -d, --datetime=datetime
  -l, --[no-]learning
  -r, --remarks=remarks
  -t, --task=task

DESCRIPTION
  Atleast 1 task id should be passed as argument to update.
     for eg. study update task-id1 task-id2 -c
     -t, --task       Updates the task title
     -r, --remarks    Updates the task remarks
     -l, --learning   Updates the task to a learning task
     -c, --completed  Updates the task status to completed
     -d, --datetime   Update Date/time (DD/MM/YYYY HH:mm) for the task
                      Default is today
                      Or +NumberOfDays; -t +9 -> add a task to a date i.e,today + 9 days

See code: src/commands/update.js