A tiny Todoist CLI program. Takes simple input and dumps it in your inbox or another project. Takes advantage of natural language processing to assign due dates, tags, etc.
- Tod - Table of Contents - Installation - Crates.io (Linux, Mac, and Windows) - AUR (Arch-based Linux) - GitHub (Linux, Mac, and Windows) - Usage - Discovering the commands - Usage Examples - Shell script examples - Sort, schedule, prioritize, and process tasks - Update Tod only if it is out of date - How task priority is determined - Why I made this - Contributing - Setting up for development - Configuration - Location - Values - lastversioncheck - mockselect - mockstring - mockurl - nextid - path - spinners - timezone - token - vecprojects - Related projects
Will ask for your Todoist API token on the first run
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ```
Install Tod
bash
cargo install tod
```bash
yay tod-bin ```
Clone the project
bash
git clone git@github.com:alanvardy/tod.git
cd tod
./test.sh # run the tests
cargo build --release
You can then find the binary in /target/release/
```bash
tod -h
A tiny unofficial Todoist client
Usage: tod [OPTIONS] [COMMAND]
Commands:
task
project
version
help Print this message or the help of the given subcommand(s)
Options:
-o, --config
And also use it to dig into subcommands
```bash
tod task -h
Usage: tod task
Commands: create Create a new task list List all tasks in a project next Get the next task by priority complete Complete the last task fetched with the next command help Print this message or the help of the given subcommand(s)
Options: -h, --help Print help -V, --version Print version
```
```bash
tod -q Buy more milk today
tod task create
tod task create --content "Write more rust" --project code
tod project import
tod task next
tod project process
tod task complete && tod task next
tod tasks list --scheduled --project work
tod tasks list --project work ```
bash
echo "" && \
echo "=== EMPTYING INBOX ===" && \
tod project empty --project inbox && \
echo "" && \
echo "=== SCHEDULING DIGITAL ===" && \
tod project schedule --project digital && \
echo "" && \
echo "=== SCHEDULING PHYSICAL ===" && \
tod project schedule --project physical && \
echo "" && \
echo "=== PRIORITIZING DIGITAL ===" && \
tod project prioritize --project digital && \
echo "" && \
echo "=== PRIORITIZING PHYSICAL ===" && \
tod project prioritize --project physical
echo "" && \
echo "=== PROCESSING DIGITAL ===" && \
tod project process --project digital && \
echo "" && \
echo "=== PROCESSING PHYSICAL ===" && \
tod project process --project physical;
bash
tod version check || cargo install tod --force
Tasks are ranked by points and the first is returned, the points are the sum of the following:
I am a developer who uses Todoist to reduce stress and cognitive overhead, by delegating things that a machine does well to a machine. This CLI application scratches some very specific itches for me, and I hope that it may be of use to others as well!
Some points around my general strategy:
tod project process)tod project empty, schedule, and prioritize)Contributions are welcome, just please open up an issue before putting too much work into a PR. If you would like clarification on any tickets, be sure to ask! I also enjoy supporting people newer to Rust and am happy to review PRs and give pointers.
You will need to install tarpaulin with cargo install cargo-tarpaulin before running ./test.sh locally.
Data is stored in JSON format in $XDG_CONFIG_HOME/tod.cfg. This defaults to:
~/.config/tod.cfg on Linux~/Library/Application Support/tod.cfg on Mac
type: nullable string
default: null
possible_values: any string in format YYYY-MM-DD
Holds a string date, i.e. "2023-08-30" representing the last time crates.io was checked for the latest tod version. Tod will check crates.io a maximum of once per day.
type: nullable non-negative integer
default: null
possible values: any integer 0 or greater
Used in test only, instead of displaying a select picker in test instead the zero-based number will be used to choose the item.
type: nullable string
default: null
possible values: any string
Used in test only, instead of displaying a text in test instead the string will be returned.
type: nullable string
default: null
possible values: any URL
Used in test only, gives the location of the mock server so that external APIs are not used in test.
type: nullable string
default: null
possible values: null or any positive integer in string form
When task next is executed the ID is stored in this field. When task complete is run the field is set back to null
type: string
default: $XDG_CONFIG_HOME/tod.cfg
possible values: Any path
Location of the tod configuration file
type: nullable boolean
default: null
possible values: null, true, or false
If true, the datetime selection in project schedule will go straight to natural language input.
type: nullable boolean
default: null
possible values: null, true, or false
Controls whether the spinner is displayed when an API call occurs. Useful for cases where the terminal output is captured. null is considered the same as true.
You can also use the environment variable DISABLE_SPINNER to turn them off.
bash
DISABLE_SPINNER=1 tod task create
type: string
default: No default
possible values: Any timezone string i.e. "Canada/Pacific"
You will be prompted for timezone on first run
type: string
default: No default
possible values: Any valid token
You will be prompted for your Todoist API token on first run
type: Nullable array of objects
default: null
possible values: List of project objects from the Todoist API
Projects are stored locally in config to help save on API requests and speed up actions taken. Manage this with the project subcommands. The strange naming is because projects was used in previous versions of tod.