/TerminalToDo

Stay organized in your command line!

Primary LanguagePythonMIT LicenseMIT

TerminalToDo

Stay organized in your command line!

Requirements

  • At it's infancy, this this CLI only works on mac and linux. A windows verion is in developement.
  • On mac, it works only on the bash shell. To enter the bash shell, run bash. Compatibility with other shells will arive in the future.
  • Python3 must be installed.

Installation & Setup

In your home directory, clone this repo.
cd ~
git clone https://github.com/gadhagod/TerminalToDo/

Edit or create your .bashrc file.

nano ~/.bashrc

Append the following to the file:

alias ttd='python3 ~/TerminalToDo/ttd'

Now run ttd in your terminal. You should see a help message.

Usage: ttd [OPTIONS] COMMAND [ARGS]...

  A command line interface for you to stay organized in your terminal.

Options:
  --help  Show this message and exit.

Commands:
  add   Create a to-do
  cls   Finish all to-dos
  rm    Finish a to-do
  view  View your to-dos

Commands

ttd add creates a to-do with one parameter. The argument passed will be the name of your to-do.
ttd rm completes a to-do with one parameter. The argument passed is the to-do to be removed.
ttd cls completes all to-dos.
ttd view displays all your to-dos.