https://github.com/insomnimus/todo
A todo app you will actually use, written in rust.
https://github.com/insomnimus/todo
app cli notes productivity rust todo
Last synced: over 1 year ago
JSON representation
A todo app you will actually use, written in rust.
- Host: GitHub
- URL: https://github.com/insomnimus/todo
- Owner: insomnimus
- License: mit
- Created: 2021-06-07T13:48:15.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-25T19:32:47.000Z (almost 5 years ago)
- Last Synced: 2025-02-06T14:58:13.359Z (over 1 year ago)
- Topics: app, cli, notes, productivity, rust, todo
- Language: Rust
- Homepage:
- Size: 69.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# todo
Todo is a simple command line note keeping application.
# The Motive
Todo is very simple and definitely not one of the flashy todo apps. But there're reasons for that:
- It doesn't have any distractions and just gets to the point. That means less time spent on configuring everything.
- Note taking and viewing is a command away so it's very convenient to just scratch something or to refresh yourself on your ideas.
- It won't remind you to do your chores, instead it waits for you to want to be productive. This way, you are more efficient at your work and you procrastinate less.
# Features
Todo's simplicity doesn't make it completely featureless, here is what todo offers:
- Hooks: you can configure any number of pre/post hooks, depending on the command you ran. Hooks are plain commands you put in the todo's configuration file.
- Shell completions: todo comes with shell completions.
- Tags: you can put tags to your todos.
- Importance level: You can set an importance level to any todo.
- Filters: you can filter your todos by the name, tag, index or importance level.
- Coming soon: git integration (for now you can achieve similar results with the hooks).
- Coming soon: Editor integration.
# Installation
Todo is written in rust and is tested with cargo version 1.54.0. You will need an up to date rust environment to compile it.
Todo is not yet published on crates.io but it is planned, meanwhile you can follow any of the following methods to install it.
### Installation with git and cargo
```sh
git clone https://github.com/insomnimus/todo
cd todo
git checkout main
cargo install --path . --locked
```
The shell completion files will be written to the project root after cargo installs todo on your system.
### Installation with cargo only (no shell completions)
`cargo install --locked --git https://github.com/insomnimus/todo --branch main`
# Usage
The usage is pretty straightforward:
```sh
# create a new todo
todo new "title" "body"
# create a new todo with tags and an importance level
todo new "title" "body" --tag=tag1,tag2,tag3 --level=2
# view 5 most recent todos
todo
# view all your todos
todo list
# view todos by their tag
todo list -t my_tag
# search for todos by their title, also using glob patterns
todo list "do *"
# remove todos by the title, again using glob but glob is not a requirement
todo remove "mail *"
# remove a range of todos (start from the 5th most recent, ending with the 10th most recent)
todo remove -i 5:10
# view todos in reverse order
todo list -i=-1:0
# display 3 random todos
todo random 3
# display 2 random todos that also have the "project" tag
todo random 2 --tag project
```
There are of course more things you can do, please run `todo --help` for the full usage.
# Config File Syntax and Hooks
Hooks are configured in the todo's config file, which uses the TOML format.
A hook has these fields:
- `cmd`: a command and its arguments as an array of strings.
- `working_dir`: the commands working directory as a string. Defaults to the calling processes pwd.
- `silent`: a boolean value indicating whether the command should be silent, defaults to `false`.
- `abort_on_error`: a boolean value indicating whether the other hooks should stop being executed if this hook returns a non-0 exit code. Defaults to `true`.
The only required field is the `cmd`.
### Hook Types
Currently there are 4 types of hooks you can set:
- `pre_new`: run before the "new" command takes effect.
- `post_new`: run after the "new" command takes effect.
- `pre_remove`: run before the "remove" command takes effect.
- `post_remove`: run after the "remove" command takes effect.
### Some Example Hooks
Hooks are defined in the `[hooks]` table in the todo config file.
```toml
# [...]
[hooks]
[[hooks.pre_new]]
cmd = [
"echo", "creating new note!"
]
[[hooks.post_remove]]
cmd = [
"bash", "run_git_backup.sh"
]
working_dir = "/home/insomnia/notes/"
silent = true
abort_on_error = false
```
To find out where the config file is kept, run `todo where --config`.