https://github.com/t1anz0ng/iftree

iftree help understand container networks by visualizing network interfaces( veth bridge lo ) relation , output in text, table, images and dot language.
https://github.com/t1anz0ng/iftree

bridge cli cni go graphviz-dot netlink netns veth

Last synced: 1 day ago
JSON representation

iftree help understand container networks by visualizing network interfaces( veth bridge lo ) relation , output in text, table, images and dot language.

• Host: GitHub
• URL: https://github.com/t1anz0ng/iftree
• Owner: t1anz0ng
• License: apache-2.0
• Created: 2022-07-27T14:17:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T22:37:35.000Z (over 1 year ago)
• Last Synced: 2024-08-04T04:04:24.947Z (4 months ago)
• Topics: bridge, cli, cni, go, graphviz-dot, netlink, netns, veth
• Language: Go
• Homepage:
• Size: 1.35 MB
• Stars: 113
• Watchers: 2
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        




# ☘️ iftree

`iftree` command visulize local network interfaces.

intent for better understanding container networks :D

[![golangci-lint](https://github.com/t1anz0ng/iftree/actions/workflows/golangci-lint.yml/badge.svg?branch=main)](https://github.com/t1anz0ng/iftree/actions/workflows/golangci-lint.yml)

[![CodeQL](https://github.com/t1anz0ng/iftree/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/t1anz0ng/iftree/actions/workflows/codeql-analysis.yml)

[![Go Report](https://goreportcard.com/badge/github.com/t1anz0ng/iftree)](https://goreportcard.com/badge/github.com/t1anz0ng/iftree)

[![Github All Releases](https://img.shields.io/github/downloads/t1anz0ng/iftree/total.svg)](https://img.shields.io/github/downloads/t1anz0ng/iftree/total.svg)



---





**Features**

- [x] **visualize** Veth/bridge connections

- [x] **table** output

- [x] **rich** text

- [x] rendering **image**

- [x] output **graphviz DOT** language

## usage

```

iftree [options]

Example:

  generate tree output

    # sudo iftree 

  generate png graph with name "output.png"

    # sudo iftree --graph -Tpng -Ooutput.png

  generate image with dot

    # sudo iftree --graph -Tdot | dot -Tpng  > output.png

  generate table output

    # sudo iftree --table

```

### text

```shell

sudo iftree

```

### graph

support `jpg`, `svg`, `png`

```shell

sudo iftree --graph -Tpng

```

Or create an ouput image with any [graphviz](https://www.graphviz.org/) compatible renderer.

e.g: online editor: https://dreampuf.github.io/GraphvizOnline

```shell

sudo iftree --graph -Tdot

```

generate image using `dot`(http://www.graphviz.org/download/#executable-packages)

```shell

sudo iftree --graph -Tdot | dot -Tpng  > output.png

```

### table

```shell

sudo iftree --table

```

![table](./asset/sample-table.png)