readme.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

<p align="center">
  <img height="200" src="https://u.peppe.rs/lz.png">
</p>

### About

`dijo` is a habit tracker. It is curses-based, it runs in
your terminal. `dijo` is scriptable, hook it up [with
external
programs](https://github.com/NerdyPepper/dijo/wiki/Auto-Habits)
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**: [configure `dijo` to
   track your `git` commits](https://github.com/NerdyPepper/dijo/wiki/Auto-Habits)!

### Install

The official installation method is using `cargo`. Unofficial packages exist for some package managers as well.

#### Cargo

```shell
# dijo requires rustc >= v1.42
$ rustup update

$ cargo install dijo
```
If you aren't familiar with `cargo` or Rust, read the [complete
installation](https://github.com/NerdyPepper/dijo/wiki/Install)
guide.

#### Nix

`dijo` on nixpkgs (maintained by [@Infinisil](https://github.com/Infinisil)):

```
$ nix-env -f channel:nixpkgs-unstable -iA dijo
```

#### Arch Linux

Install [`dijo-bin`](https://aur.archlinux.org/packages/dijo-bin/) or [`dijo-git`](https://aur.archlinux.org/packages/dijo-git) from the AUR.

### 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)

### Gallery

Day mode, shows days of the current month:

![day.png](https://u.peppe.rs/qI.png)

Week mode, shows weekly summary for the weeks of the month:

![weekly.png](https://u.peppe.rs/HZ.png)

[![Awesome Humane Tech](https://raw.githubusercontent.com/humanetech-community/awesome-humane-tech/main/humane-tech-badge.svg?sanitize=true)](https://github.com/humanetech-community/awesome-humane-tech)