aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: bb25e52c64f68f3317e7fe93d3c2d5e896503ff4 (plain) (blame)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# qview

A terminal dashboard for exploring and inspecting a Gentoo system using Portage metadata.

Built with Rust and Ratatui.

---

## Features

* Browse installed Gentoo packages
* Inspect package metadata
  * Version
  * Repository
  * Maintainer
  * License
  * Homepage
  * Installed size
* View package USE flags
  * Enabled flags
  * Default flags
* Search installed packages
* Dashboard overview
  * Installed package count
  * World package count
  * Installed size

---

## Screenshots

Ui changes kind of frequently right now, take these with a grain of salt

### Dashboard

![Dashboard](.github/images/qview-dashboard.png)

### Installed Packages View

![Installed Packages](.github/images/qview-installed-packages.png)


### Search Popup

![Search](.github/images/qview-search.png)

---

## Installation

### Gentoo (via guru overlay)

qview is available as an ebuild in the official [Gentoo guru overlay](https://wiki.gentoo.org/wiki/Project:GURU).

Install with:

```bash
emerge app-misc/qview
```

### Build from source

Requirements:
* Rust (stable)
* Cargo
* Gentoo Linux

Clone the repository:

```bash
git clone https://github.com/Pablu23/qview
cd qview
```

Build:

```bash
cargo build --release
```

Run:

```bash
./target/release/qview
```

---

## Development Environment

This repository includes a `flake.nix` for development environments.

The flake is intended for:
* dependency management
* reproducible development shells
* editor tooling

It is **not currently used for building or packaging qview itself**.

Enter the development shell with:

```bash
nix develop
```

---

## Usage

### Keybinds

#### Global

| Key   | Action       |
| ----- | ------------ |
| `q`   | Quit         |
| `Tab` | Switch views |

---

### Installed Packages View

| Key      | Action                 |
| -------- | ---------------------- |
| `j`      | Move down              |
| `k`      | Move up                |
| `/`      | Open search            |
| `n`      | Next search result     |
| `N`      | Previous search result |
| `Ctrl+d` | Scroll down            |
| `Ctrl+u` | Scroll up              |

---

### Search

| Key     | Action         |
| ------- | -------------- |
| `Enter` | Confirm search |
| `Esc`   | Close search   |

---

## Roadmap

The project is still early in development. Planned features include:
- [x] Public guru ebuild
- [ ] Portage package search/browser
- [ ] Improved information in package metadata
  - [ ] RDEPEND
  - [ ] BDEPEND
  - [ ] SLOT
  - [ ] Keywords
  - [ ] New version available?
- [ ] Filtering installed packages
  - [ ] World packages
  - [ ] Explicitly installed packages
  - [ ] Repository filters
  - [ ] USE flag filters
- [ ] Better package USE Flag rendering
- [ ] Improved dashboard statistics
- [ ] Portage news reader
- [ ] Search improvements
- [ ] Sorting options
- [ ] Async package metadata loading

---

## Project Structure

```text
src/
├── app.rs        # Application state and logic
├── event.rs      # Keyboard/event handling
├── ui.rs         # Ratatui rendering
├── main.rs       # Application bootstrap
└── gentoo/
    ├── package.rs
    ├── portage.rs
    └── useflags.rs
```

---

## Motivation

qview exists to provide a lightweight terminal interface for exploring Gentoo package information without repeatedly invoking multiple Portage utilities manually.

The focus is:
* fast navigation
* clean terminal UX
* useful metadata presentation
* native Gentoo integration

---

## License

MIT License

Copyright 2026 Pablu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


> Documentation written with AI assistance and edited for accuracy.