Update Readme
This commit is contained in:
parent
c6c8cfb223
commit
1a531f1047
@ -28,7 +28,28 @@ pyinstaller --onefile --name iottb --distpath ~/opt iottb/main.py
|
||||
to be able to run it as `iottb` if `~/opt' is a directory on your PATH.
|
||||
A executable which should be able to run on linux is included in the repo.
|
||||
## Basic Invocation
|
||||
```bash
|
||||
Usage: iottb [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Options:
|
||||
-v, --verbosity Set verbosity [default: 0; 0<=x<=3]
|
||||
-d, --debug Enable debug mode
|
||||
--cfg-file PATH Path to iottb config file [default:
|
||||
/home/seb/.config/iottb/iottb.cfg]
|
||||
--help Show this message and exit.
|
||||
|
||||
--dry-run BOOLEAN currently NOT USED! [default: True]
|
||||
|
||||
Commands:
|
||||
add-device Add a device to a database
|
||||
init-db
|
||||
sniff Sniff packets with tcpdump
|
||||
|
||||
Debugging Commands:
|
||||
show-all Show everything: configuration, databases, and...
|
||||
show-cfg Show the current configuration context
|
||||
```
|
||||
You can get the subcommand specif helptext by adding the `--help` option.
|
||||
## Configuration
|
||||
### Env Vars
|
||||
- IOTTB_CONF_HOME
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user