https://github.com/unkwusr/nctok
A program for interactive navigating through weighted hierarchical structured data and analyzing them
https://github.com/unkwusr/nctok
hierarchy menu navigation sort terminal tree tui weighted
Last synced: over 1 year ago
JSON representation
A program for interactive navigating through weighted hierarchical structured data and analyzing them
- Host: GitHub
- URL: https://github.com/unkwusr/nctok
- Owner: UnkwUsr
- License: mit
- Created: 2024-03-29T20:01:46.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T06:54:25.000Z (over 2 years ago)
- Last Synced: 2024-04-24T18:19:12.379Z (over 2 years ago)
- Topics: hierarchy, menu, navigation, sort, terminal, tree, tui, weighted
- Language: Rust
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nctok
A TUI utility for interactive exploring weighted hierarchical structured data.
("weighted" means that each item have its own value - number)
Due to simplicity of input format, it's easy to write your own scripts that
produces data you want to analyze, fast, right in the shell. See
[examples](doc/examples.md).
## What?
Any hierarchical structured data, with fields having weights (number
characteristic). Imagine filesystem with file size being weight characteristic.
When displaying, each level items gets sorted by weight (sum of weights of
children items). This way you see "heaviest" (= with max weight) item at each
level of hierarchy.
## Demo
File space usage (files size):
Git commits count per file, linux kernel 6.8 repo:
## Features
* interactive navigation
* items sorted by their recursive weight-sums
* accepts any data from stdin, so you can easily make your owns (see
[examples](doc/examples.md))
* input format can be altered (see [configuration](#configuration) section)
* interface:
* preview window (can be toggled)
* human-readable big numbers formatting (can be toggled)
## Usage
```shell
... | nctok
```
Where `...` should produce output in format:
```
```
For concrete usecases see [examples](doc/examples.md).
### Keys/control
* `j`/`k` - go down/up in list
* `l`/`h` - go deep down/up (inside/out)
* `g` - go to top (very first item)
* `G` - go to bottom (latest item)
* `w` - toggle preview window
* `a` - toggle human-readable numbers formatting
* `q` - quit
## Configuration
```
$ nctok --help
...
Options:
--reverse Invert sort order
Parser:
--number-delimiter
Delimiter between items number value and path [default: " "]
--path-separator
Separator in items path [default: /]
Interface:
--preview
Show preview window for entry under cursor (can also toggle with 'w' key)
--no-human-readable
Disable formatting big numbers in human-readable (can also toggle with 'a' key)
```
## Installation
### On Arch Linux
AUR package: [nctok-git](https://aur.archlinux.org/packages/nctok-git/)
### With cargo (from [crates.io](https://crates.io/crates/nctok))
```shell
cargo install nctok
```
### From sources
```shell
cargo install --path .
```
## Inspiration
* [ncdu](https://dev.yorhel.nl/ncdu) - (ncurses) disk usage analyzer. This is
main source of inspiration. I took exactly their idea and made unified
interface for analyzing any data with the same (and a bit better) interface.
* [vifm](https://github.com/vifm/vifm) - terminal file manager. I took preview
window from it.
* [tokei](https://github.com/XAMPPRocky/tokei) - lines-of-code counter. Well,
at very first I wanted tokei+ncdu experience, so this project was born.