Skip to content

Harsh-bin/TODO-CLI-and-TUI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

48 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒŸ TODO CLI and TUI BOTH ๐ŸŒŸ

TUI PREVIEW

CLI PREVIEW

todo_cli.mp4

๐Ÿš€ Features

  • Both TUI and CLI Feature: use whatever version you like
  • Task Lists: Track daily ๐ŸŒž, weekly ๐Ÿ“…, and monthly ๐ŸŒ™ tasks.
  • Progress Bars: Watch bars fill up as you complete tasks!
  • Earn Stars: Complete tasks โ†’ collect โญ (1 per task)!
  • Score Board: Track lifetime achievements and shows the ( total tasks completed/total tasks added ) in reward window .
  • Daily/Weekly/Monthly Goals: Reset automatically at midnight ๐Ÿ•›, Monday ๐ŸŒ…, and month-end ๐ŸŒŒ.
  • Build Streaks: Finish all daily tasks โ†’ streak +1! (UPDATE AT 12AM MIDNIGHT EVERYDAY)
  • Weekly Stars: Collect 7 stars/week โ†’ unlock a "Streak Boost" ๐Ÿš€.
  • Fail-Safe: Miss a day? Streak resets to 0 ๐Ÿ˜ข.
  • Notes: Save text ๐Ÿ“„ or links ๐Ÿ”—
  • Edit Notes: Delete or edit notes๐Ÿ“„ anytime.
  • Countdowns: Supports adding multiple countdown windowsโณ with Countdown labels.
  • Remove Tasks: Changed your mind? Delete tasks easily ๐Ÿ—‘๏ธ.

๐Ÿ’กTips

  • Delete tasks you won't do โ†’ keeps stats accurate ๐ŸŽฏ else streak will reset. removed tasks doesn't counts.

๐Ÿ”ต TUI USAGES

Adding multiple tasks ๐Ÿ“œ

use | between tasks to add multiple tasks at once spacing doesn't matter.

Example Gym|Call Mom | Do Maths | Do Physics|Do Chemistry

Result

   1.Gym
   2.Call Mom
   3.Do Math
   4.DO Physics
   5.Do Chemistry

๐Ÿ”ด CLI USAGES

Run

todocli --help

Usage:

todocli [command] [options]

๐Ÿ“Œ Basic Commands:

  • todocli --helpย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย Show this help message

๐Ÿ“ Task Operations:

  • todocli add task --period [day/week/month] --tasks "Task1|Task2"
  • todocli remove task --period [day/week/month] --task "Task Name"
  • todocli complete task --period [day/week/month] --task "Task Name"

๐Ÿ“š Note Operations:

  • todocli add note --type [text/link] --content "Content"
  • todocli edit note
  • todocli delete note

๐ŸŽฏ Target Dates:

  • todocli set-target "Label" "YYYY-MM-DD"
  • todocli remove target date

๐Ÿ” Show Commands:

  • todocli show day task
  • todocli show week task
  • todocli show month task
  • todocli show all tasks
  • todocli show notes
  • todocli show streak
  • todocli show target dates

๐Ÿ” Examples:

  • todocli add task --period day --tasks "Gym|Math homework"
  • todocli complete task --period day --task "Gym"
  • todocli show week task
  • todocli set-target "Exam" "2023-12-15"

๐Ÿ› ๏ธ Setup

Install dependencies:

For Linux:

ubuntu/debian

sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
sudo apt update && sudo apt install gum jq bc util-linux bsdutils

Archlinux

sudo pacman -S util-linux gum jq bc # Arch based system

๐Ÿ“ข For any other distro install these "gum jq bc util-linux or bsdutils if needed" this should work with no errors.

๐Ÿ› ๏ธ Installation

  1. Clone this repository
 git clone https://github.com/Harsh-bin/TODO-CLI-and-TUI.git  
 cd TODO-CLI-and-TUI
 chmod +x ./install.sh
 ./install.sh
  1. Restart terminal and run
  2. ** ๐Ÿ“ข MAKE SURE TO RUN TODO TUI ONCE BEFORE RUNNING TODOCLI ELSE IT WILL NOT WORK**
  todo # TUI MODE
  todocli [command] [options] # CLI MODE
  1. Everything done NOW enjoyโœŒ๏ธ

Uninstalling todo app

chmod +x ./uninstall.sh
./uninstall.sh

About

A small todo app which is both "TUI" and "CLI" based on gum that has bunch of features like adding tasks for day ,week or months ,setting target date , adding notes,reward window and many more.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages