Skip to content

Commit 2385b0b

Browse files
committed
Add basic usage info
1 parent 4bd9981 commit 2385b0b

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
11
![Simple CI](https://github.com/NamelessOne91/bisturi/actions/workflows/simple_ci.yml/badge.svg)
22

33
# bisturi
4-
Poor men's network analyzer
4+
A toy project network packet analyzer
55

66
The compiled binary executable for bisturi will attempt to create a new raw socket and bind it to a network interface using syscalls.
77
This will fail unless the program is run with root privileges, which is not advisable.
88

99
You can use [setcap](https://man7.org/linux/man-pages/man8/setcap.8.html) to grant the binary executable *only* the capability to operate on raw sockets.
1010
This is the default behaviour of the included Makefile's **build** command.
11+
12+
13+
## Usage
14+
15+
You can build the binary executable with the `make build` command.
16+
17+
The following flags are available to customize bisturi's behaviour:
18+
19+
| Flag | Type | Default | Meaning
20+
| :---:|:--:|:--:|:--|
21+
| i | string | eth0 | network interface for which the packets will be analyzed |
22+
| p | string | all | protocl filter - 'all' equals to no filter |
23+
24+
Running bisturi with the provided `make run` command is functionally equivalent to running bisturi with the following flags, which are its defaults:
25+
26+
`bisturi -i eth0 -p all`
27+

0 commit comments

Comments
 (0)