halwa

Here's a comprehensive README.md file for your halwa CLI tool:

# Halwa CLI Tool

**Halwa** is a command-line tool designed for managing tasks. It allows you to add tasks, view tasks with various sorting options, and mark tasks as completed.

## Installation

To install the Halwa CLI tool globally, run the following command:

```bash
npm install -g halwa

Setup

Note: If you're using Windows PowerShell, you may need to adjust the execution policy to allow the script to run.

PowerShell Execution Policy

To enable script execution, you may need to set the execution policy to RemoteSigned for the current user:

1. Open PowerShell as Administrator:

   Right-click on the PowerShell icon and select "Run as Administrator."

2. Set Execution Policy:

   Run the following command to set the policy:

   Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned

   This policy allows you to run scripts that are either locally created or signed by a trusted publisher.

3. Verify the Policy:

   Check the current execution policy with:

   Get-ExecutionPolicy -List

4. Revert to Restricted (if needed):

   To revert to a restricted policy that prevents all script execution:

   Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Restricted

Usage

halwa addtask

Add a new task to your task list.

Usage:

halwa addtask

Prompts:

• Enter the task description.
• Select the priority (High, Medium, Low).
• Enter the due date in YYYY-MM-DD format.
• Enter the due time in HH:mm format.
• Confirm if the task is completed.

halwa tasklist [sortOption]

Display all tasks with optional sorting.

Usage:

halwa tasklist [-i|-p|-t|-d]

Sort Options:

• -i: Sort by index (default).
• -p: Sort by priority.
• -t: Sort by due time.
• -d: Sort by status (completed or incomplete).

halwa checkTask

Mark a task as completed.

Usage:

halwa checkTask

Steps:

• Select a task from the list to mark as completed.

Troubleshooting

• If you encounter issues with PowerShell execution policies, follow the setup instructions to adjust the policy.
• For errors loading or saving tasks, ensure that you have write permissions to the directory where task.json is stored and that the file is not corrupted.

License

No license specified. Feel free to use and modify the code as needed.

Contact

For any issues or questions, please reach out via the repository's issue tracker or contact the maintainer directly.

---

Happy task managing! 🎯

### Key Sections in the README:
1. **Installation**: Instructions to install the tool.
2. **Setup**: Details on configuring PowerShell to allow script execution.
3. **Usage**: Descriptions of available commands and their options.
4. **Troubleshooting**: Common issues and their solutions.
5. **License**: Information about the project's licensing (or lack thereof).
6. **Contact**: How to get support or report issues.

Feel free to adjust the content based on your preferences or additional details you want to include.