Skip to content

Commit

Permalink
Rename --name to --session
Browse files Browse the repository at this point in the history
  • Loading branch information
Alvaro Muñoz committed Apr 26, 2023
1 parent f2424d9 commit 65b6eff
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ A configuration file will be created in `~/.config/mrva/config.yml`. The followi
### Submit a new query

```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

### Download the results

```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
Expand All @@ -34,12 +34,12 @@ gh mrva list [--json]
### Check scan status

```bash
gh mrva status --name <run name> [--json]
gh mrva status --session <session name> [--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.

Expand Down
4 changes: 2 additions & 2 deletions cmd/download.go
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down

0 comments on commit 65b6eff

Please sign in to comment.