termstat 0.1.0

A CLI tool to get information about your terminal command usage history
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

# 💻 Termstat - A tracker for Commands !!!(Still in development)!!!
A complete local command tracker, no Cloud involved. Feel free to try it, but keep in mind, that some things may break in following updates.

## How it works
1. A Shell prehook logs all commands into a logfile
2. If the sync command is called the logfile entries are inserted into a Sqlite database

## Installation
- [x] Nix
    - [x] Systemd
- [ ] Cargo
- [ ] From Source

### Shell prehook
Add the following to your .zshrc
~~~sh
eval "$(termstat init --shell-type zsh)"
~~~
### Nix
Install nix and configure terstat via Homemanager

```Nix
# flake.nix

# add input
inputs = {
    termstat = {
        url = "github:marc55s/termstat";
        inputs.nixpkgs.follows = "nixpkgs-unstable";
    };
}
# add overlay to your outputs
outputs = inputs@{self, nixpkgs, termstat ... }:
    pkgs = import nixpkgs {
        inherit system;
        overlays = [ inputs.termstat.overlays.default];
    }

# home.nix
{termstat, ...}:
{
    programs.termstat = {
        enable = true;
        enableZshIntegration = true;
        systemd = {
            enable = true;
            onCalendar = "DayOfWeek Year-Month-Day Hour:Minute:Second";  # defaults to daily
        }

        # Not supported yet
        # enableBashIntegration = true;
        # enableFishIntegration = true;
        # enableIonIntegration = true;
        # enableNushellIntegration = true;
    };

    # add the modules to your imports
    imports = [termstat.homeManagerModules.default];
}

```
## Usage
After the initalization the following commands are available:
### Help

![](/screenshots/help_command.png)

### Sync with database

![](/screenshots/sync_command.png)

### Statistics

![](/screenshots/stats_daily.png)

For the statistics these other commandflags are available:
```Bash
termstat stats # default to termstat stats --daily/-d
termstat stats --weekly/-w
termstat stats --monthly/-m
```

## Currently Supported Shells
- [x] Zsh
- [ ] Bash
- [ ] Fish
- [ ] ...

## Commands
- [x] sync
- [x] stats --daily, --weekly, --monthly
- [x] init --shell-type [SHELL]
- [ ] clean

## To Do
- [x] Switch from flags to subcommands
- [x] List available Commands
- [x] Systemd service for syncing automatically
- [x] Nix Packaging / Module
- [ ] Support multiple Shelltypes
- [ ] Display statistics in a fancy way with a TUI-Lib
- [ ] Write Installation Manual
- [ ] Publish to Crates.io
- [ ] Far future: Support for multiple databases / Syncing across devices

## Queries
- [x] Most used command of the day|week|month
- [ ] Commands sorted by length
- [ ] Common command pipes
- [ ] Top exectued binaries