diff --git a/README.md b/README.md index 60860e2f6..e363eefb5 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,22 @@ We do not take any responsibility for damage caused by the usage of this tool. See the [setup instructions](https://fraunhofer-aisec.github.io/gallia/setup.html). +First create a config template with `--template`, store it to a file called [`gallia.toml`](https://fraunhofer-aisec.github.io/gallia/config.html), and adjust it to your needs. +`gallia` reads this file to set the defaults of the command line flags. +All options correspond to a command line flag; the only required option for scans is `gallia.scanner.target`, for instance `isotp://can0?src_addr=0x123&dst_addr=0x312&tx_padding=0xaa&rx_padding=0xaa`. + +``` +$ gallia --template > gallia.toml +``` + +You are all set to start your first scan, for instance read the diagnostic trouble codes: + ``` -$ gallia primitive uds dtc --target "isotp://can0?src_addr=0x123&dst_addr=0x312&tx_padding=0xaa&rx_padding=0xaa" read +$ gallia primitive uds dtc read ``` -For specifying the `--target` argument see the [transports documentation](https://fraunhofer-aisec.github.io/gallia/transports.html). +The target can also be specified by the `--target` option on the command line. +For the format of the `--target` argument see the [transports documentation](https://fraunhofer-aisec.github.io/gallia/transports.html). ## Acknowledgments diff --git a/src/gallia/cli.py b/src/gallia/cli.py index 196fb0e67..687a454fa 100644 --- a/src/gallia/cli.py +++ b/src/gallia/cli.py @@ -37,7 +37,7 @@ def load_parsers() -> Parsers: parser = argparse.ArgumentParser( description="""gallia COMMANDs are grouped by GROUP and SUBGROUP. Each GROUP, SUBGROUP, or COMMAND contains a help page which can be accessed via `-h` or `--help`. -Every command line option can be set via a TOML config file. Check `gallia --template` for a starting point. + A few command line option can be set via a TOML config file. Check `gallia --template` for a starting point. """, epilog="""https://fraunhofer-aisec.github.io/gallia/index.html""", )