Files
darkfi/bin/dnetview/README.md
2022-05-04 09:29:56 +02:00

53 lines
1.1 KiB
Markdown

# Dnetview
A simple tui to explore darkfi p2p network topology. Explore:
1. Active p2p nodes
2. Outgoing, incoming and manual sessions
3. Each associated connection and recent messages.
Dnetview is based on the design-pattern Model, View, Controller. We
create a logical seperation between the underlying data structure or
Model; the ui rendering aspect which is the View; and the Controller or
game engine that makes everything run.
## Install
```shell
% git clone https://github.com/darkrenaissance/darkfi
% cd darkfi
% make BINS=dnetview
```
## Usage
On first run, dnetview will create a config file in .config/darkfi. You
must manually enter the RPC ports of the nodes you want to connect to
and title them as you see fit.
Check the [example config file](dnetview_config.toml) for more details.
Run dnetview as follows:
```shell
dnetview -v
```
Navigate up and down using `j` and `k`.
## Logging
Dnetview creates a logging file in /tmp/dnetview.log. To see json data
and other debug info, tail the file like so:
```shell
tail -f /tmp/dnetview.log
```
Or use multitail for colored output:
```shell
multitail -c /tmp/dnetview.log
```