clone url: git://git.m455.casa/rodo
A todo-list program for the command line.
This is a hobby project I built for myself to keep track of todos related to my hobbies.
I take no responsibility for anything that rodo deletes.
Backup anything you don't want deleted.
Inline code
: Inline code signifies package names, filenames, or commandsCode block
: Code blocks signify file contentsBelow is a list of platforms that rodo can run on:
The following items must be downloaded and installed before you can use rodo:
This section is for users who are familiar with git, a Unix-like command line environment, or scripting.
git clone git://git.m455.casa/rodo
cd rodo
sudo make install-global
rodo
Note: To uninstall, run sudo make uninstall-global
rodo help
- Displays the help messagerodo add "your task here"
- Adds the message inside of quotation marks to your todo listrodo ls
- Displays your todo listrodo rm 2
- Removes the third item from your list. (The list starts at 0)Note: You may need to run rodo ls
to see which number corresponds to which item in your list before running rodo rm <number>
rodo's source code exists in a public git repository. This makes accessing the code convenient, because you don't need to sign in or register for an account to download it.
You can use tools such as git
to download rodo's source code. You
will need the source code to install rodo.
git clone git://git.m455.casa/rodo
Note: This will create a rodo
directory in your current directory.
You can either install rodo globally or locally on your system. A global installation allows all users on a machine to use rodo, while a local installation only allows one user to use rodo.
See the options below for installing rodo:
This option will install rodo into /usr/local/bin/
.
This section assumes you have downloaded rodo.
cd rodo
sudo make install-global
This option will install rodo into ~/.local/bin/
.
This section assumes you have downloaded rodo.
cd rodo
sudo make install-local
If you wish to have rodo exist elsewhere on your system, you can also
compile a single-file executable. Compiling a single-file executable
allows you to place the executable in convenient places on your
system, such as a directory on your $PATH
.
This section assumes you have downloaded rodo.
Warning: You will have to manually uninstall custom installations
cd rodo
make install-custom location=~/path/to/custom/location
Example: In step 2., you could run make install-custom location=~/bin/
Depending on your installation method, you can uninstall a global or local installation of rodo.
See the options below for uninstalling rodo:
This option will remove the rodo
executable from /usr/local/bin/
.
This section assumes you have downloaded rodo.
cd rodo
sudo make uninstall-global
This option will remove the rodo
executable from ~/.local/bin/
.
This section assumes you have downloaded rodo.
cd rodo
sudo make uninstall-local
This section will teach you how to use rodo's commands.
This section assumes you have installed rodo.
Before using rodo, you will need to initialize it. This means rodo will create a ~/.rodo
file.
rodo init
y
The help message will provide a list of available commands. This is list useful in case you forget the name of a command or how to use a command.
rodo help
Displaying your list will allow you to view the items you have added to your list. You will notice numbers beside the items in your list.
Note: These numbers are useful references for when you want to remove items from your list. For more information, see the Removing an Item from Your List topic.
rodo ls
Adding an item to your list will save it to a text file to access later.
rodo add "this is an example of an item using double quotation marks"
When removing an item from your list, you can reference the numbers beside each item when Displaying Your List. You can use these numbers when removing an item from your list.
rodo rm 1
Note: You may need to run rodo ls
first to see which numbers correspond
with which item in your list.
When changing an item in your list, you can reference the numbers beside each item when Displaying your list.
rodo update 2 "This is new text"
Note: You may need to run rodo ls
first to see which numbers correspond
with which item in your list.
This section lists and describes rodo's commands.
init
intializes the ~/.rodo
filehelp
displays the help messagels
displays your listadd
adds an item to your listrm
removes an item from your listupdate
replaces the contents of an item with new textrodo init
rodo help
rodo ls
rodo add "this is an item"
rodo rm 1
rodo update 1 "This is new text"