#weighted #navigation #hierarchy #tui #tree

app nctok

A program for interactive navigating through weighted hierarchical structured data and analyzing them. Weighted means that each item have its own value - number

1 unstable release

0.1.0 Apr 23, 2024

#82 in Visualization

MIT license

17KB
344 lines

nctok

A program for interactive navigating through weighted hierarchical structured data and analyzing them. (weighted means that each item have its own value - number)

This is a nice tool for analyzing and researching datasets, and simplicity of input format makes it easy to write your own scripts that produces data you want to analyze fast, right in shell (like something in files, git meta data (number of commits per each file), etc. For more see Examples section).

Demo

File space usage:

Git commits per each 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 section)
  • interface:
    • preview window (can be toggled)
    • human-readable big numbers formatting (can be toggled)

Usage

... | nctok

Where ... should produce output in format:

<number> <path/to/item>
<number> <path/to/another_item>

For concrete usecases see Examples section.

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 <NUMBER_DELIMITER>
          Delimiter between items number value and path [default: " "]
      --path-separator <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)

Examples

WIP

Installation

With cargo (from crates.io)

cargo install nctok

From sources

cargo install --path .

Inspiration

  • 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 - terminal file manager. I took preview window from it.
  • tokei - lines-of-code counter. Well, at very first I wanted tokei+ncdu experience, so this project was born.

Dependencies

~7–17MB
~201K SLoC