xaizek / zograscope (License: AGPLv3 only) (since 2018-12-07)
Mainly a syntax-aware diff that also provides a number of additional tools.
<root> / docs / zs-tui.md (10ba760e56155b82b72ff7c80c58d6644e1cab06) (1,412B) (mode 100644) [raw]

`zs-tui` is a TUI version for processing files, whose scope is yet to be
defined.  So far it lists files or functions along with their size and parameter
count and allows viewing those items in source code as well as viewing dump of
their internal representation.

It's not clear if it's worth adding diffing functionality here.  It's probably
not, which means that this tool will be mostly for interactive browsing or
similar activities and other tools might be extracted out of it.


`zs-tui` `[options...]` _[paths...]_

Paths can specify both files and directories.  When no path is specified, "." is

Tool-specific Options

`--lang` \
here this common option also limits set of files to process


Supported Vim-like shortcuts:

 * `G` -- to last line
 * `gg` -- to first line
 * `j` -- to the item below
 * `k` -- to the item above

Other shortcuts:

 * *files* view:
    - `c` -- enter code view
    - `d` -- enter dump view
    - `f` -- switch to functions view
    - `q` -- quit the application
 * *functions* view:
    - `c` -- enter code view
    - `d` -- enter dump view
    - `f` -- switch to files view
    - `q` -- quit the application
 * *code* view:
    - `c/q` -- leave code view
 * *dump* view:
    - `d/q` -- leave dump view


**zograscope**(7) for common options and list of all tools there.

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/zograscope

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/zograscope

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master