2.5 KiB
Executable File
rodo
A simple to-do list tool for people who live on the command-line
By: Jesse Laprade
Table of Contents
Platforms
- GNU/Linux
Requirements
Downloading
-
Via Browser
- Download this repository by clicking the Clone or download button at the top right, then choose Download ZIP from the drop-down list
-
Via Git
- Run
git clone https://github.com/m455/rodo
at the command line
- Run
Setup
GNU/Linux
-
Setup a $PATH
- Create a directory for your
$PATH
by runningmkdir ~/bin/
- Associate your
$PATH
with the ~/bin/ folder you created by runningecho "export PATH=~/bin:\$PATH" >> .bashrc
- Create a directory for your
-
Using the binary
- Copy the rodo binary file to your
$PATH
folder by runningcp /path/to/rodo ~/bin/
- Make the rodo binary file executable by running
chmod u+x ~/bin/rodo
- Copy the rodo binary file to your
-
Creating a wrapper
- Create an empty wrapper file by running
touch ~/bin/rodo
. - Add the following contents show below to it
#!/usr/bin/env bash racket ~/path/to/rodo.rkt "$@"
For example, if you downloaded the project to your ~/downloads/ folder you would change the line
racket ~/path/to/rodo.rkt "$@"
toracket ~/downloads/rodo/rodo.rkt "$@"
- Save the file
- Make the rodo wrapper file executable by running
chmod u+x ~/bin/rodo
- Create an empty wrapper file by running
Usage
init - Initializes a file in ~/.rodo/todo-list by default
ls - Lists items from the list
add - Adds an entry to the list
rm - Removes an item from the list
Note: You may have to run rodo ls
to see which number corresponds to which item when removing items.
Examples
The examples below assume that you have rodo set up in your $PATH
init - rodo init
ls - rodo ls
add (Single-word entry) - rodo add bread
add (Multi-word entry) - rodo add "go to the bank"
rm - rodo rm 1
Configuring rodo
Right now, the configurations can be found in the config.rkt file. Settings such at program name, path and directory can be set here.