https://github.com/inimaz/keepon

Track your tasks and improve your time management with a simple cli
https://github.com/inimaz/keepon

command-line-tool productivity time-management-tools

Last synced: 5 months ago
JSON representation

Track your tasks and improve your time management with a simple cli

• Host: GitHub
• URL: https://github.com/inimaz/keepon
• Owner: inimaz
• License: mit
• Created: 2024-04-02T14:00:24.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-05T10:55:08.000Z (6 months ago)
• Last Synced: 2024-12-19T14:12:00.095Z (5 months ago)
• Topics: command-line-tool, productivity, time-management-tools
• Language: TypeScript
• Homepage: https://inimaz.github.io/keepon/
• Size: 769 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![KeepOn](https://raw.githubusercontent.com/inimaz/keepon/main/docs/media/keepOn-logo.png)

# keepOn

_Track your tasks and improve your time management with a simple cli._

![alt text](https://raw.githubusercontent.com/inimaz/keepon/main/docs/media/image.png)

# How it works

1. Add your tasks with the urgency, importance and estimated time in minutes

1. `keepOn` will prioritize those tasks base on your inputs and tell you which task to do next

   ![alt text](https://raw.githubusercontent.com/inimaz/keepon/main/docs/media/keepOn-createTask.gif)

# Install

```

npm install -g @inimaz/keepon

```

# Usage

See all commands with `k -h`

```sh

$ k -h

Usage: k [options] [command]

Options:

  -h, --help                                                           display help for command

Commands:

  show [options]                                                       Show all tasks

  block                                                            Set the status of a task to blocked

  check                                                            Check/uncheck task

  clear                                                                Clear all completed tasks

  create  [description] [urgency] [importance] [estimatedTime]  Create a new task

  get                                                              Get all info of a task

  start                                                            Start a task

  update [options]                                                 Update a task

  agenda|a                                                             Show the agenda of today as if you had to do all the tasks today

  reindex                                                              Reindex tasks so that their IDs go from 1 to N

  help [command]                                                       display help for command

```

If no command is passed, by default it will show the dashboard (`k show` command).

![alt text](https://raw.githubusercontent.com/inimaz/keepon/main/docs/media/keepOn-show.gif)

# How the priority is calculated

The priority gives the order in the dashboard. It is calculated based on the urgency, the estimated time and importance of the task. The formula is:

```

priority = urgency * importance / estimatedTime

```

# Inspired by

- [Taskbook](https://github.com/klaudiosinani/taskbook)