diff --git a/README.md b/README.md index 1ab5ba9..0b0569a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## Configuration A configuration file will be created in `~/.config/gh-mrva/config.yml`. The following options are supported: -- `codeql_path`: Path to CodeQL distribution +- `codeql_path`: Path to CodeQL distribution (checkout of [codeql repo](https://github.com/github/codeql)) - `controller`: NWO of the MRVA controller to use - `list_file`: Path to the JSON file containing the target repos @@ -14,7 +14,7 @@ A configuration file will be created in `~/.config/gh-mrva/config.yml`. The foll ### Submit a new query ```bash -gh mrva submit [--codeql-path] [--controller ] --language --session [--list-file ] --list [--query | --query-suite ] +gh mrva submit [--codeql-path] [--controller ] --language --session [--list-file ] --list [--query | --query-suite ] ``` Note: `codeql-dist`, `controller` and `list-file` are only optionals if defined in the configuration file