https://github.com/1995parham/dijo
Scriptable, Curses-based, Digital habit tracker - forked from https://github.com/oppiliappan/dijo
https://github.com/1995parham/dijo
habit habit-tracking habits rust tracker tui
Last synced: 3 months ago
JSON representation
Scriptable, Curses-based, Digital habit tracker - forked from https://github.com/oppiliappan/dijo
- Host: GitHub
- URL: https://github.com/1995parham/dijo
- Owner: 1995parham
- License: mit
- Created: 2024-11-02T20:00:14.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-07T06:57:46.000Z (3 months ago)
- Last Synced: 2025-07-07T07:40:04.173Z (3 months ago)
- Topics: habit, habit-tracking, habits, rust, tracker, tui
- Language: Rust
- Homepage:
- Size: 415 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
### About
`dijo` is a habit tracker. It is curses-based, it runs in
your terminal. `dijo` is scriptable, hook it up with external programs
to track events without moving a finger. `dijo` is modal,
much like a certain text editor.
### Features
- **Vim like motions**: navigate `dijo` with `hjkl`!
- **`dijo` is modal**: different modes to view different
stats!
- **Vim like command mode**: add with `:add`, delete with
`:delete` and above all, quit with `:q`!.
- **Fully scriptable**
### Install
To get the latest release of `dijo`, prefer installing it
via `cargo`. Unofficial packages exist for some package
managers as well. You can also browse the
[Releases](https://github.com/NerdyPepper/dijo/releases)
page for prebuilt binaries.
#### Cargo
```shell
# dijo requires rustc >= v1.42
$ rustup update
$ cargo install dijo
```
### Usage
`dijo` has a [detailed
wiki](https://github.com/NerdyPepper/dijo/wiki/), here are
some good places to start out:
- [Getting started](https://github.com/NerdyPepper/dijo/wiki/Getting-Started)
- [Automatically tracking habits](https://github.com/NerdyPepper/dijo/wiki/Auto-Habits)
- [Command reference](https://github.com/NerdyPepper/dijo/wiki/Commands)
## Design Notes
habit:
```
type: bit/count
stats:
year:
month:
bit:
|-- dates - array
count:
|-- dates - k,v pairs
```
habit:
-type: `bit/count`
-stats: `k,v (dates, bit/count)`
Cycle habit type:
- `n` states
- cycles through states on `prev` `next` events
- represent by symbol/char
- `ser` to `usize`?
Modes:
- Day mode - shows all days of 1 month
- shift months on Previous/Next
- Week mode?
- Aggregate stats for 1 week
- show 4 weeks per view
- bar graph for count and bit
Command mode:
- Add command
- `add `
- `add --type [--goal ]`
- Interactive add command via questionnaire?
- Edit command?
- `edit `
- `edit --goal `
- `edit --type `
- Interactive edit command via questionnaire?
- Delete command
- `delete `
- `delete _ (deletes focused?)`
- Chronological nav:
- `month-prev` `mprev`
- `month-next` `mnext`
Interface:
- Move view port if focused view goes outside bounds
- Tab completion for command mode? Requires Lex table
- Move command window to bottom, styling
- Prefix command window with `:`
Undo-tree:
- Store app states in memory
- Should store diffs? Or entire state?
- Ideal undo depth limit?