By utilizing a simple and minimal usage syntax, that requires a flat learning curve, task-organizer enables you to effectively organize your tasks and notes across multiple boards from within your terminal. All data are written atomically to the storage in order to prevent corruptions, and are never shared with anyone or anything.
npm install --global taskorganizer
- Organize tasks & notes to boards
- Board & timeline views
- Priority & favorite mechanisms
- Search & filter items
- Archive & restore deleted items
- Lightweight & fast
- Data written atomically to storage
- Progress overview
- Simple & minimal usage syntax
- Update notifications
- Data stored in JSON file at
~/.taskListner.json
$ organize --help
Usage
$ organize [<options> ...]
Options
none Display board view
--help, -h Help log message
--version, -v Current version
--task, -t Create task
--note, -n Create note
--remove -r Remove items
--done, -d Mark task done/pending
--priority, -p Update priority of task
--board -b Change board name
--edit, -e Edit item description
--move, -m Move item between boards
--find, -f Find item/boards
--star, -s Star/unstar item
--copy, -c Copy item description to clipboard
--unpin, -u Remove all completed tasks
--timeline, -i Display timeline view
--begin, -b Begin/Pause task
--list, -l List items by attributes
--erase, -e Clear all the items
--mark Add book mark
--unmark Remove book mark
--get Copy bookmark to clipboard
--bookmarks Display all bookmarks
Examples
$ organize
$ organize --help
$ organize --version
$ organize --task Check commit b:project p:2
$ organize --note Complexity of Merge-sort is O(nlogn) b:project
$ organize --remove 1
$ organize --done 2
$ organize --priority 2 p:3
$ organize --board c:project n:coding
$ organize --edit 2 Some new task description
$ organize --move 1 b:college
$ organize --find college
$ organize --star 3
$ organize --copy 1 2 3
$ organize --unpin
$ organize --timeline
$ organize --begin 2
$ organize --list pending
$ organize --erase
$ organize --mark http://abc.com abc
$ organize --unmark abc
$ organize --get abc
$ organize --bookmarks
Invoking task-organizer without any options will display all saved items grouped into their respective boards.
In order to display all items in a timeline view, based on their creation date, the --timeline option can be used.
The following is a minor walkthrough containing a set of examples on how to use task-organizer.
To create a new task use the --task/-t option with your task's description following right after. There are two optional arguements b:<board-name> and p:<priority>. By default board name is Default and priority is 3.
$ organize -t Improve documentation
$ organize -t Improve documentation b:coding p:2
To create a new note use the --note/-n option with your note's body following right after. There are two optional arguements b:<board-name> and p:<priority>. By default board name is Default and priority is 3.
$ organize -n Mergesort worse-case O(nlogn)
$ organize -n Mergesort worse-case O(nlogn) b:college p:2
To delete an item, use the --remove/-r options followed by the id of the target items. Duplicate ids are automatically filtered out.
$ organize -r 2
To mark a task as complete/incomplete, use the --done/-d option followed by the id of the target task. Note that the option will update to its opposite the complete status of the given tasks, thus checking a complete task will render it as pending and a pending task as complete. Duplicate ids are automatically filtered out.
$ organize -d 1
To set a priority level for a task while initializing it, include id and the p:x syntax in the task's description, where x can be an integer of value 1, 2 or 3. Note that all tasks by default are created with a normal priority - 3.
3- Normal priority2- Medium priority1- High priority
$ organize -p 1 p:3
To change the name of the board, use the --board/-b option follwed by c:x, where x is the board name to be changed and then n:y, where y is the new name of the board.
$ organize -b c:coding n:college
To change the description of an item, use the --edit/-e option follwed by the id of the target task and new description to be assigned.
$ organize -e 2 New task description
To move an item to another boards, use the --move/-m option, followed by the target item id, prefixed by the b: symbol, and the name of the destination board. The default board Default can be accessed through the default keyword.
$ organize -m 1 myboard reviews
To mark an item as favorite, use the --star/-s option followed by the id of the target item. The functionality of this option is the same as the one of the above described --done option.
$ organize -s 1
To copy to your system's clipboard the description of one or more items, use the --copy/-y option followed by the ids of the target items. Note that the option will also include the newline character as a separator to each pair of adjacent copied descriptions, thus resulting in a clear and readable stack of sentences on paste.
$ organize -c 1 2 3
To delete/clear all complete tasks at once across all boards, use the --unpin/-u option.
$ organize --unpin
In order to display all items in a timeline view, based on their creation date, the --timeline option can be used.
$ organize --timeline
To mark a task as started/paused, use the --begin/-b option followed by the id of the target task. The functionality of this option is the same as the one of the above described --check option.
$ organize -b 2
To list a group of items where each item complies with a specific set of attributes, use the --list/-l option followed by the desired attributes. Board names along with item traits can be considered valid listing attributes. For example to list all pending tasks, the following could be used. The available attributes are pending/in-process/done/notes.
$ organize -l pending
To find for task/board, use the --find/-f option, followed by id of the task or name of the board.
$ organize -l coding
To remove all the elements and boards use --erase.
$ organize --erase
To create a new bookmark use the --mark option with bookmark's link followed by name of the bookmark.
$ organize --mark https://www.npmjs.com npm
To remove a bookmark use the --unmark option with bookmark's name.
$ organize --unmark npm
To copy a bookmark use the --get option with bookmark's name.
$ organize --get npm
To display all bookmarks use the --bookmarks option. All the names along with links will be displayed.
$ organize --bookmarks
- signale - Highly configurable logging utility
- chalk - Terminal string styling done right
- clipboardy - Access the system clipboard (copy/paste)
- boxen - Create boxes in the terminal
- meow - CLI app helper
- carbon - Create and share beautiful images of your source code.
- Mansimar Anand (@anandman03)
The older version of this project can be found (here)