@stevescruz/task-master

1.4.0 • Public • Published


Task Master CLI

Task Master is a command-line todo list. It allows you to write your tasks, set priorities, view existing tasks and view the next tasks due.

Goal   |    Getting Started   |    Commands   |    Technologies   |    Uninstallation   |    License

CLI adds a new pending task

Goal

The goal is to create a todo list command-line application using Node.js that prioritizes productivity and contains the most important features without overwhelming the user.

Getting Started

Prerequisites: to run this application, you need Node.js v14.14.0 (or higher) installed on your computer.

From your terminal:

# Install the CLI globally
$ npm install -g @stevescruz/task-master

# Execute the CLI
$ task-master

Potential issues

On Windows you may not be able to execute the task-master CLI because of your execution policies' configurations.

Execution policies are responsible for determining what scripts your machine is allowed to execute, thus helping avoid malicious code.

I recommend trying to execute task-master through CMD and PowerShell to see which one works. In case both do not work, then it is necessary to change the execution policy for the PowerShell.

Read more about execution policies at the Microsoft Docs.

Read more about this at Stack Overflow (includes a solution).

From your PowerShell terminal:

# Check your scopes and their execution policies
Get-ExecutionPolicy -List

# Set the execution policy for the scope that will solve your problem
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted

# Whenever you want, you can revert the changes and set your scope's execution policy back to its original settings
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Undefined

# NOTE: The scopes and execution policies used here are just examples.

Commands

  • task-master task [subcommand]

    • When no subcommand is specified for task, it will execute the list subcommand.
  • task-master task add <description [-p <priority>]

    • Creates a new task.
    • The task's description is mandatory.
    • The task's -p (alias: --priority) flag is optional. It sets a task's priority and can only receive L, N or H as a parameter.
    • When the -p option is ommitted, by default, the new task's priority is set to N.
  • task-master task delete <id>

    • Deletes a task.
    • The task's id is mandatory.
  • task-master task done <id>

    • Marks a task's status as done, hiding it from being listed by the task list command.
    • The task's id is mandatory.
    • task-master task tag <id> <tag>
    • Marks a task's tag property with the provided <tag>, allowing it to be filtered by the task list -f <tag> command.
    • The task's id is mandatory.
    • task-master task untag <id>
    • Removes a task's tag property.
    • The task's id is mandatory.
  • task-master task list [-s <status>] [-f <tag>]

    • Displays all tasks.
    • -s <status> (alias: --show <status>) is an optional flag that forces the task list command to only display the tasks whose status property correspond to the provided status (available options for <status> are done or pending).
    • -d (alias: --dates) is an optional flag that forces the task list command to display tasks grouped by their creation date.
  • task-master task next

    • Displays all tasks.
    • -f <tag> (alias: --filter <tag>) is an optional flag that forces the task list command to only display the tasks whose tag property corresponds to the provided tag.
  • task-master task next

    • Displays the next task of each priority that was not completed.
    • Does not display tasks with status done.
    CLI adds a new pending task
  • task-master export [target_directory]

    • Exports a tasks.json file containing the saved tasks to the target_directory.
    • If the target_directory is ommitted, it exports the file to the current working directory.
  • task-master import <filepath>

    • Imports a .json file containing the saved tasks from the mandatorily specified filepath.
    • If successful it overwrites the data for the previously existing tasks.
  • task-master config [--no-colors]

    • Updates the configurations for the task-master CLI.
    • If all options are ommitted, it sets all configurations to their default values.
    • The task's --no-colors flag is optional. It sets the enableTerminalColors property to false, disabling colored output when using the task-master CLI.
    • When the --no-colors flag is ommitted, by default, it sets the enableTerminalColors property to true, enabling colored output when using the task-master CLI.

Technologies

This project was developed with the following technologies:

Uninstallation

You can uninstall task-master CLI through your terminal with the following command:

# Uninstall the CLI globally
$ npm uninstall -g @stevescruz/task-master

📝 License

This project is under the MIT license.


Get in touch with me!

Install

npm i @stevescruz/task-master

DownloadsWeekly Downloads

1

Version

1.4.0

License

MIT

Unpacked Size

47.2 kB

Total Files

41

Last publish

Collaborators

  • stevescruz