diff --git a/README.md b/README.md index 16bec68..6ba9bfa 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ A configuration file will be created in `~/.config/mrva/config.yml`. The followi ### Submit a new query ```bash -gh mrva submit [--codeql-path] [--controller ] --lang --name [--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 @@ -22,7 +22,7 @@ Note: `codeql-dist`, `controller` and `list-file` are only optionals if defined ### Download the results ```bash -gh mrva download --name --output-dir [--download-dbs] [--nwo ] +gh mrva download --session --output-dir [--download-dbs] [--nwo ] ``` ### List sessions @@ -34,12 +34,12 @@ gh mrva list [--json] ### Check scan status ```bash -gh mrva status --name [--json] +gh mrva status --session [--json] ``` ## Contributing -gh-mrva is a work in progress. If you have ideas for new fixes or improvements, please open an issue or pull request. +`gh-mrva` is a work in progress. If you have ideas for new fixes or improvements, please open an issue or pull request. If possible, tests should be added for any new fixes. We favour testing with real file systems or processes where possible. diff --git a/cmd/download.go b/cmd/download.go index 8bf44e0..99ddfee 100644 --- a/cmd/download.go +++ b/cmd/download.go @@ -34,8 +34,8 @@ func init() { downloadCmd.Flags().StringVarP(&outputDirFlag, "output-dir", "o", "", "Output directory") downloadCmd.Flags().BoolVarP(&downloadDBsFlag, "download-dbs", "d", false, "Download databases (optional)") downloadCmd.Flags().StringVarP(&nwoFlag, "nwo", "n", "", "Repository to download artifacts for (optional)") - statusCmd.MarkFlagRequired("session") - statusCmd.MarkFlagRequired("output-dir") + downloadCmd.MarkFlagRequired("session") + downloadCmd.MarkFlagRequired("output-dir") } func downloadArtifacts() {