mrva/gh-mrva
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename --name to --session

Browse Source
This commit is contained in:
Alvaro Muñoz
2023-04-26 22:24:22 +02:00
parent f2424d9bfa
commit 65b6eff68a
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -14,7 +14,7 @@ A configuration file will be created in `~/.config/mrva/config.yml`. The followi
### Submit a new query ### Submit a new query
```bash ```bash
gh mrva submit [--codeql-path<path to CodeQL>] [--controller <controller>] --lang <language> --name <run name> [--list-file <list file>] --list <list> [--query <query> | --query-suite <query suite> ] gh mrva submit [--codeql-path<path to CodeQL>] [--controller <controller>] --language <language> --session <session name> [--list-file <list file>] --list <list> [--query <query> | --query-suite <query suite> ]
``` ```
Note: `codeql-dist`, `controller` and `list-file` are only optionals if defined in the configuration file 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 ### Download the results
```bash ```bash
gh mrva download --name <run name> --output-dir <output directory> [--download-dbs] [--nwo <owner/repo>] gh mrva download --session <session name> --output-dir <output directory> [--download-dbs] [--nwo <owner/repo>]
``` ```
### List sessions ### List sessions
@@ -34,12 +34,12 @@ gh mrva list [--json]
### Check scan status ### Check scan status
```bash ```bash
gh mrva status --name <run name> [--json] gh mrva status --session <session name> [--json]
``` ```
## Contributing ## 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. If possible, tests should be added for any new fixes. We favour testing with real file systems or processes where possible.

4
cmd/download.go
View File

@@ -34,8 +34,8 @@ func init() {
downloadCmd.Flags().StringVarP(&outputDirFlag, "output-dir", "o", "", "Output directory") downloadCmd.Flags().StringVarP(&outputDirFlag, "output-dir", "o", "", "Output directory")
downloadCmd.Flags().BoolVarP(&downloadDBsFlag, "download-dbs", "d", false, "Download databases (optional)") downloadCmd.Flags().BoolVarP(&downloadDBsFlag, "download-dbs", "d", false, "Download databases (optional)")
downloadCmd.Flags().StringVarP(&nwoFlag, "nwo", "n", "", "Repository to download artifacts for (optional)") downloadCmd.Flags().StringVarP(&nwoFlag, "nwo", "n", "", "Repository to download artifacts for (optional)")
statusCmd.MarkFlagRequired("session") downloadCmd.MarkFlagRequired("session")
statusCmd.MarkFlagRequired("output-dir") downloadCmd.MarkFlagRequired("output-dir")
} }
func downloadArtifacts() { func downloadArtifacts() {