Skip to content

Latest commit

 

History

History
111 lines (75 loc) · 2.83 KB

README.md

File metadata and controls

111 lines (75 loc) · 2.83 KB
Raw

todo

TODO CLI APP

Description

This is intended for managing the tasks locally. By default uses $HOME/.todo.json file to store the data. (you can change this using --config option any time)

Sample

Sample

Getting Started

Contains following commands

  1. Add (todo add)
  2. List (todo ls)
  3. Delete (supports space separated multiple params) (todo delete)
  4. Mark Complete (supports space separated multiple params) (todo complete)
  5. Mark Pending (supports space separated multiple params) (todo pending)

Dependencies

  • Cobra
  • Viper
  • Simple table

Installing

Choose appropriate (binary Releases)[https://github.com/dineshr93/todo/releases]

  • Rename the binary to 'todo'.
  • Add the binary to your environment path and use it.

Executing program

  • How to run the program
COMMAND FORMAT:
todo add "project - task - jiraLink"
todo add "YOUR_PROJECT_NAME - TASK_NAME - http://www.yourcompany.jira.com"

todo complete TASKID
<!-- you can also mark multiple tasks to mark complete by passing space separated ids  -->
todo complete 1 2 ..

todo pending TASKID
<!-- you can also mark multiple tasks back to mark pending by passing space separated ids  -->
todo pending 1 2 ..

todo delete TASKID
<!-- you can also mark multiple tasks for deletion by passing space separated ids  -->
todo delete 1 2 ..

Help

any issues please raise an bug reguest

>todo -h

        TODO CLI APP (for issue -> https://github.com/dineshr93/todo/issues)

1. Add (todo add)
2. List (todo ls)
3. Delete (supports space separated multiple params) (todo delete)
4. Mark Complete (supports space separated multiple params) (todo complete)
5. Mark Pending (supports space separated multiple params) (todo pending)

Usage:
  todo [command]

Available Commands:
  add         add a todo Format: Project - task - JIRA link
  complete    Mark a task as completed(supports space separated multiple params)
  delete      Delete a task from the list(supports space separated multiple params)
  help        Help about any command
  ls          List all todos
  pending     Mark a task as pending(supports space separated multiple params)

Flags:
      --config string   config file (default is $HOME/.todo.json)
  -h, --help            help for todo
  -t, --toggle          Help message for toggle

Use "todo [command] --help" for more information about a command.

Authors

Dinesh Ravi

Version History

  • 1.0.0
    • Initial Release

License

This project is licensed under the Apache License 2.0 or GPL-3.0 - see the LICENSE file for details

Acknowledgments