tidytask

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 20, 2025 License: GPL-3.0 Imports: 1 Imported by: 0

README ΒΆ

TidyTask 🫧

TidyTask is a simple CLI tool for managing your to-do list, built with Go using Cobra.

Features ✨

TidyTask is designed for users who want a no-nonsense way to manage their tasks from the terminal

  • Fast: Instant access to tasks, no logins or loading screens.
  • Minimal: Shows only the information you need, no distractions.
  • Concise: Short, intuitive commands and powerful flags.
  • Offline: Fully local, no internet or accounts required.

Installation πŸ“¦

You can install TidyTask by building from source. Homebrew and AUR releases coming soon.

Linux/Mac 🐧🍎
  • Ensure the go and git packages are installed through your system's package manager
  • Run the following commands in your terminal:
  • git clone https://github.com/tm-craggs/TidyTask.git
  • cd tidytask
  • go build -o tidytask
  • sudo mv tidytask /usr/local/bin
Windows πŸͺŸ
  • Install Go for Windows and Git for Windows
  • Run the following commands in Command Prompt or PowerShell:
  • git clone https://github.com/tm-craggs/TidyTask.git
  • cd tidytask
  • go build -o tidytask.exe
  • move .\tidytask.exe C:\Program Files\TidyTask\
  • Ensure the folder is added to PATH

Usage πŸš€

Once installed, you can start using TidyTask directly from your terminal.

Add

To add a task, run:

tidytask add "First Task"

Tasks can be given a due date using --due:

tidytask add "Finish Homework" --due 2025-06-01

Tasks can also be marked as high priority using --priority:

tidytask add "Submit Essay" --due 2025-06-25 --priority
List

To view your to-do list use:

tidytask list

You can use flags to just view certain types of task:

tidytask list --priority
Complete/Remove/Reopen

These commands are formatted the same way the same way.

  • complete β†’ Marks a task as complete
  • remove β†’ Removes a task from to-do list
  • reopen β†’ Marks completed tasks as incomplete

To complete task numbers 1, 2 and 3:

tidytask complete 1 2 3

These commands support batch operations through the --all flag:

tidytask remove --all

The --all flag can be used with constrictions to target specific types of task

tidytask reopen --all --priority

The search command displays all tasks that match a certain keyword. By default, it searches all fields.

tidytask search "homework"

You can specify with flags which fields to search. For example, this is a search for tasks with the number 2025 in their due date:

tidytask search 2025 --due

Like with list, you can use flags just view certain types of task. For example, this is a search for all priority tasks with essay in the title:

tidytask search essay --title --complete
Undo

To reverse the previous action, run:

tidytask undo
Help

You can view all commands and general information, use:

tidytask --help

To view the help page for a specific command use:

tidytask [command] --help

Contributions 🀝

Contributions are encouraged! See Wishlist for some ideas. I will respond to pull requests and issues as soon as possible.

Wishlist πŸ’­

  • Add support for a configuration file so that users can control the colour scheme and column layout.
  • Add a basic Terminal User Interface, designed to enhance navigation without interfering with users who prefer the core command line.
  • Implement an action log table and multi-level undo

Libraries Used πŸ“š

Support ❀️

If TidyTask has been helpful to you, I’m really glad to hear it! I’m a student building free and open source tools for fun, if you’d like to support me you can do so via Ko-fi. There’s absolutely no pressure or expectation. Your encouragement and feedback mean just as much. <3

ko-fi

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Directories ΒΆ

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL