Skip to content

Latest commit

 

History

History
110 lines (94 loc) · 2.47 KB

README.md

File metadata and controls

110 lines (94 loc) · 2.47 KB

CLIear - Command Line Task Manager

CLIear is a Command Line Interface (CLI) application written in Go that helps you manage tasks efficiently. With CLIear, you can create, list, toggle, and delete local dev tasks easily.

Features

  • Add Tasks: Create new tasks with a title.
  • Edit Task names: Edit existing tasks with a new title.
  • List Tasks: View a table of all tasks with details such as title, completion status, and timestamps.
  • Toggle Tasks: Mark tasks as completed or not completed.
  • Delete Tasks: Remove tasks from the list.

Prerequisites

  • Go programming language installed on your system.

Installation

  1. Clone the repository to your local machine: 
    git clone https://github.com/abhinaeae/CLIear.git
cd CLIear
  2. Build the project: 
    go build ./src
    This will create an executable file named src.exe (on Windows) or src (on Unix-based systems).

Usage

Navigate to the directory containing the executable file, then use the following commands:

Add a Task

./src.exe -add "Task Title" -pri <priority_level[1-5]>

Example:

./src.exe -add "Fix feature 1" -pri 3

Edit a Task

./src.exe -edit <task_id>:"new_title"

Example:

./src.exe -edit <2>:"Fix: memory leak"

This edits the title of an existing task with id 2 to "Fix: memory leak"

List Tasks

./src.exe -list

This will display tasks in a tabular format:

image

Toggle Task Completion Status

./src.exe -toggle <task_id>

Example:

./src.exe -toggle 0

This changes the completion status of the task with ID 0 from incomplete to complete or vice versa.

Delete a Task

./src.exe -del <task_id>

If <task_id> is specified as -5, all tasks will be deleted.

Example:

./src.exe -del 0

This deletes the task with ID 0.

./src.exe -del -5

This clears the task list.

Invalid Command

If you run the executable without any arguments, it will display an "Invalid command" message:

./src.exe
Invalid command

Sample Workflow

  1. Add a task: 
    ./src.exe -add "Publish code"
  2. List tasks: 
    ./src.exe -list
  3. Toggle task completion: 
    ./src.exe -toggle 1
  4. Delete a task: 
    ./src.exe -del 0

Start managing your tasks with CLIear today!