work

Crates.iowork
lib.rswork
version0.4.2
sourcesrc
created_at2020-07-21 15:45:54.341585
updated_at2020-12-22 14:13:16.586711
descriptionA simple cli todo manager
homepagehttps://github.com/g-w1/work
repositoryhttps://github.com/g-w1/work
max_upload_size
id267666
size1,114,428
Jacob G-W (g-w1)

documentation

https://github.com/g-w1/work

README

Work: a terminal todo manager

screencapture

Features:

  • use a sqlite database with rusqlite

  • command line parsing with clap.rs

  • fuzzy finder built in with skim

  • config file parsing with confy

Instructions:

work ls to list all of your events. Ex:

[user@hostname ~]$ work ls
________________________________________
DONE| ID| SUMMARY
----------------------------------------
❌ | 1 | test
❌ | 2 | another another test
✅ | 3 | another test
----------------------------------------

work add <string of an event to add> add an event. Ex: work add "test"

work rm <event id> to remove an event. Ex: work rm 1

work rm fzf to remove an event or multiple through a fuzzy finder. Search through the events and press tab to select multiple.

work rm all delete the whole database of events.

work edit <event id> get to a prompt to edit an event. This will allow you to edit the name and make it done. Ex: work edit 1

work edit fzf the same as work rm fzf except multiple are not allowed.

work done <event id> Mark an event as done. Ex: work done 1

work done fzf the same as work rm fzf except marking events done. Multiple are allowed.

Configuration:

You will find a worktodo.toml file in ~/.config/worktodo/ (I think it will be on Library/Preferences/rs.worktodo/worktodo.toml on macos because that is the default config location) this is the method of configuration. The settings are self explanatory. The config file will be auto generated on the first use of work.

~/.config/worktodo/worktodo.toml

emojis = true
backticks = true
verbose = true
show_id_in_ls = true
ask_for_confirm = true

Database:

The database file will be stored at ~/.local/share/worktodo/work.db It is a sqlite database.

Limits:

  • Only works on unix systems for now (I dont have any windows stuff to test on for now). If anyone wants to test it please do!
  • on macos the config file is in a different place. i think Library/Preferences/rs.worktodo/worktodo.toml.

Install:

It is on crates.io. Yay!

cargo install work

You can also

git clone https://github.com/g-w1/work
cd work
cargo install --path .
Commit count: 67

cargo fmt