As developers, we spend a significant amount of time in our terminals. Why not have a simple, offline-friendly CLI tool to help manage your project tasks efficiently? Note CLI provides an easy-to-use task management solution, accessible anytime without requiring an internet connection.

Clone the repository and navigate to its root directory:

git clone https://github.com/aryankumar07/note_cli.git 
cd note_cli

Install dependencies and set up the package globally:

npm install -g

You can also install Note CLI using npm:

npm i @tarnished_aryan/note -g

If you encounter permission errors, try installing with sudo:

sudo npm i @tarnished_aryan/note -g

If errors persist, remove conflicting files from the specified paths in the error message and retry the installation.

To get an overview of the CLI, simply run:

note

Before using the CLI, initialize it with:

note init

This sets up the necessary configuration for Note CLI to function correctly.

To explore available commands and their usage, run:

note --help

• List all Todo containers:

  note list

• Create a new Todo container:

  note create <FileName>

• Delete a Todo container:

  note delete <FileName>

• Add a new Todo:

  note add <TodoName>

• Mark a Todo as completed:

  note done <TodoName>

• List todos from a specific container:

  note list -f <FileName>

• Add a todo to a specific container:

  note add <TodoName> -f <FileName>

• Mark a specific todo as done in a container:

  note done <TodoName> -f <FileName>

• Mark all todos as done:

  note done -a

• Mark all todos as done in a specific container:

  note done -f <FileName> -a

  🔹 Adding Priorities to Task

• Note Support 3 types : {High, Medium, low}

• THe default is set to "LOW" if not specified

  note add <TodoName> -p medium

• To add to a specific File use the -f flag

 note add <TodoName> -p medium -f <FileName>

• currently working only for Macos/Linux users

  note uninstall

We welcome contributions! To make changes:

1. Open an issue to discuss improvements.
2. Fork the repository and create a feature branch.
3. Submit a pull request with a detailed explanation.

Please ensure that updates include appropriate tests before submitting.

Enjoy seamless task management with Note CLI! 🚀