ythosa / whynote

Command Line Interface to Creating Notes/Tasks

Installation:

• Install Node.js,
• Clone this repo: git clone https://github.com/Ythosa/whynote,
• Install dependences by writing in console: npm install,
• Setup module by writing in console: npm link --force,
• Done, you can use it from your cmd.

Description:

• Command line task manager and notebook;
• whynote is easy way to mark tasks, which need to be completed;
• It is easy to install and easy to use;
• It has great functionality.

:.Documentation.:

Whynote's Commands:

• Get whynote help:

  • note --help|-h [command].

• Get whynote version:

  • note --version|-V.

• Get list of tasks and/or notes:

  • note list|l [options] ,
  • Options could be:
    • -n|--notes flag carries out a output only notes,
    • -t|--tasks - output only tasks,
    • -o|--overdue - output overdue task list;
  • --help|h - get info about this function.

• Adding task to task list:

  • note add-task|at,
  • You will need to enter:
    • Task's text,
    • Task's deadline, format is DD.MM [hh:mm];
  • --help|h flag exists to get info about this function.

• Adding note to note list:

  • note add-note|an,
  • You will need to enter:
    • Note's text,
    • Note's priority, that could be important or 3, average or 2, inessental or 1;
  • --help|h flag exists to get info about this function.

• Removing task:

  • note remove|rv <id>,
  • Removing task from task list with id,
  • Id can be:
    • all, by this way you can remove all tasks from task list,
    • <id> number of task number in task list,
    • <id1, id2, id3, ...>
    • start-end - using this syntax you can delete tasks from id peer start to id peer end;
  • --help|h - get info about this method.

• Modification task:

  • note modific|mod <id>,
  • Via this command you can change task's with id text, priority and deadline:
    • If you don't want to change task's properties, you can write in following prompts: -,
    • If you chosen note and added to it deadline, note's priority will be reset;
  • --help|h.

• Clear some list:

  • note clear <list_name>,
  • Via this command you can clear the list with the name of the input list - list_name;
  • list name can be:
    • overdue-list - to clear overdue task list,
    • task-list - to clear task list,
    • note-list - to clear note-list
    • all - to clear all lists (== remove all func)
  • --help|h.

:.Using Example.:

More you can see in assets folder of this repository.

FAQ

Q: How can I get help on some command?
A: You can use command flag --help|-h, for example: wis goto --help

Q: How can I help to develop this project?
A: You can put a ⭐ :3

Copyright 2020 Ythosa