Add usage examples to README.md.
This commit is contained in:
parent
62da103253
commit
04200ee09b
@ -49,6 +49,26 @@ Debugging Commands:
|
|||||||
show-all Show everything: configuration, databases, and...
|
show-all Show everything: configuration, databases, and...
|
||||||
show-cfg Show the current configuration context
|
show-cfg Show the current configuration context
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Usage Examples
|
||||||
|
### Initializing a database
|
||||||
|
Before devices can be added and packet captures performed, there must be a database.
|
||||||
|
Initialze a database with default values at the default location:
|
||||||
|
```bash
|
||||||
|
iottb init-db
|
||||||
|
```
|
||||||
|
### Adding a device
|
||||||
|
Typically, captures are performed for devices. To add a device (to the current default database)
|
||||||
|
```bash
|
||||||
|
iottb add-device 'Echo Dot 2'
|
||||||
|
```
|
||||||
|
if the devices is named 'Echo Dot 2'. This will get the cannonical name 'echo-dot'. This name should be used when performing
|
||||||
|
captures with `iottb`.
|
||||||
|
### Performing captures/sniffing traffic
|
||||||
|
```bash
|
||||||
|
iottb sniff -a <ipv4-addr or mac-addr> 'echo-dot'
|
||||||
|
```
|
||||||
|
to sniff traffic on the previously added device 'Echo Dot 2' which received the canonical name 'echo-dot'.
|
||||||
You can get the subcommand specif helptext by adding the `--help` option.
|
You can get the subcommand specif helptext by adding the `--help` option.
|
||||||
## Configuration
|
## Configuration
|
||||||
### Env Vars
|
### Env Vars
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user