Taskly CLI

About

Taskly is a powerful and efficient CLI tool that helps you manage your daily workflow, including tasks, time tracking, note-taking, and clipboard management.

Features

• Task Management: Add, list, mark as done, and delete tasks.
• Time Tracking: Track and log your work hours efficiently.
• Notes: Take and manage personal notes.
• Clipboard Manager: Save and organize clipboard content for later use (runs in the background).

Installation

To install Taskly globally, run:

npm install -g taskly

Alternatively, you can clone the repository and build it manually:

git clone https://github.com/mehexi/taskly.git

Usage

Once installed, simply run taskly in your terminal. The CLI will display a menu with the following options:

choices: ["todo", "Time tracking", "Notes", "Clipboard Manager", "exit"]

Todo Management

When selecting "todo", you'll be presented with the following options:

choices: [
  "📝 Add a Task",
  "📋 List Tasks",
  "✅ Mark As Done",
  "🗑️ Delete Tasks",
  "⚡ Priority Tasks",
  "🔍 Search And Filters",
  "exit"
]

• Add a Task: Create a new task.
• List Tasks: View a list of all your tasks.
• Mark As Done: Mark a task as completed.
• Delete Tasks: Remove tasks from the list.
• Priority Tasks: Focus on tasks with the highest priority.
• Search And Filters: Filter tasks by different criteria, such as status, priority, or due date.

Time Tracking

When selecting "Time tracking", you'll be presented with the following options:

choices: [
  "Start Tracking",
  "Stop Tracking",
  "Check Status",
  "View Log",
  "Back"
]

• Start Tracking: Start tracking time for a task or activity.
• Stop Tracking: Stop the time tracker when you're done with the current task.
• Check Status: Check the current status of the time tracking (whether it's active or paused).
• View Log: View a log of all previously tracked time.
• Back: Return to the main menu.

Notes

When selecting "Notes", you'll have the following options:

choices: [
  "Create a Note",
  "Edit a Note",
  "Delete a Note",
  "List Notes",
  "Search Notes",
  "Tag Notes",
  "Pin a Note",
  "Export Notes",
  "Encrypt a Note",
  "Set Reminder",
  "Back to Main Menu"
]

• Create a Note: Create a new note to store important information or reminders.
• Edit a Note: Modify an existing note.
• Delete a Note: Remove a note that you no longer need.
• List Notes: View all your notes in a list.
• Search Notes: Search for a note by keywords or tags.
• Tag Notes: Add tags to your notes for better organization and filtering.
• Pin a Note: Pin an important note to the top of your list for quick access.
• Export Notes: Export your notes to a file format of your choice (e.g., JSON, TXT).
• Encrypt a Note: Encrypt a note for added security.
• Set Reminder: Set a reminder for a specific note to receive a notification later.
• Back to Main Menu: Return to the main menu.

Clipboard Manager

The Clipboard Manager helps you save and organize items you copy to the clipboard. It runs in the background to monitor clipboard changes and allow you to access previous clipboard content. When selecting "Clipboard Manager", you'll have the following options:

choices: [
  "View Clipboard History",
  "Clear Clipboard History",
  "Back"
]

• View Clipboard History: View all items you've copied to the clipboard.
• Clear Clipboard History: Clear the stored clipboard history.
• Back: Return to the main menu.

Note: The Clipboard Manager must be running in the background to track clipboard activity properly. Ensure you keep the application open for continuous monitoring.

Exit

Exit the application and return to your terminal.

Data Storage

The data for Taskly CLI (tasks, notes, time logs, clipboard history, etc.) will be stored in a folder named /taskly located in the root directory of the project.

This folder contains all the necessary files to manage the persistent data for the CLI tool. Make sure to back up this folder if needed.