ducktrace-tui 0.1.0

ducktrace-tui – a TUI for browsing logs and managing services
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
111

# **ducktrace-tui**

  
A terminal user interface for browsing logs and managing services – aiming to provide both good UX as well as DX.  

## **Features**

- **📁 Browse local log files** *(default ~/.config/duckTrace/)*

- **🌐 Secure network support - using SSH**

- **⚙️ List and view logs of system and user services** *(via journalctl)*

- **🔍 Scroll through logs with arrow keys, PageUp/Down**

- **👁️ Follow logs in real‑time** *(tail)*

- **🛠️ Start, stop, restart services**

- **🦆 Works seamlessly with:**
  - [ducktrace-loggger](https://github.com/quackhack-mcblindy/ducktrace-logger) *(Rust apps)* 
  - [ducktrace-python](https://github.com/quackhack-mcblindy/ducktrace-python) *(Python apps)* 
  - [ducktrace-sh](https://github.com/quackhack-mcblindy/ducktrace-sh) *(Bash scripts)*
  - [sytemd](https://github.com/systemd/systemd) *(System & User service management)*


<br>   
  
## **Installation**

  
#### **NixOS (using flakes)**

  
Add the flake input and overlay to your configuration:  

```nix
{
  inputs.ducktrace-tui.url = "github:QuackHack-McBlindy/ducktrace-tui";

  outputs = { self, nixpkgs, ducktrace-tui, ... }: {
    nixosConfigurations.myMachine = nixpkgs.lib.nixosSystem {
      modules = [
        {
          environment.systemPackages = [
            ducktrace-tui.packages.${system}.default
          ];
        }
      ];
    };
    
  };}
```

  
  

#### **Build from source**


```bash
$ git clone https://github.com/QuackHack-McBlindy/ducktrace-tui
$ cd ducktrace-tui
$ cargo build --release
# Run the binary
./target/release/ducktrace-tui
``` 
  
    

## **Configuration**

  
The TUI respects these environment variables (they override defaults):  
  
`$DT_LOG_PATH` – directory containing log files *(default: ~/.config/duckTrace/)*  
`$DT_SSH_HOST` - hostname of the machine to browse logs on  
`$DT_SSH_USER` - username to connect to
`DT_SSH_PORT` - SSH port to connect on *(default: 22)*  
  
No other configuration is required – log files with the .log extension are automatically discovered.  
    
  
## **Usage**

  
Run `ducktrace-tui` in your terminal.  
  
  
#### **Keybindings**  
  
| Key              | Action                                         |
|------------------|------------------------------------------------|
| `Tab`            | Switch focus between left (sources) and right (log) panels |
| `↑` / `↓`        | Navigate sources or scroll log                 |
| `PageUp`/`PageDown` | Scroll log by page                          |
| `Enter`          | Load selected source (file or service log)     |
| `f`              | Toggle follow mode (tail log) – right panel only |
| `a`              | Show service actions (start/stop/restart) – left panel only |
| `s` / `t` / `r`  | In action menu: start, stop, restart           |
| `Esc`            | Close popup (error or action menu)             |
| `q`              | Quit                                           |
    

  
<br><br>
  

## **License**

**MIT**