https://github.com/bagtoad/gh-sarif
A GitHub CLI extension for interacting with Code Scanning analyses and SARIF files
https://github.com/bagtoad/gh-sarif
gh-extension
Last synced: 8 months ago
JSON representation
A GitHub CLI extension for interacting with Code Scanning analyses and SARIF files
- Host: GitHub
- URL: https://github.com/bagtoad/gh-sarif
- Owner: BagToad
- License: mit
- Created: 2023-11-12T21:19:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-02T20:02:29.000Z (over 1 year ago)
- Last Synced: 2025-01-12T07:14:14.263Z (over 1 year ago)
- Topics: gh-extension
- Language: Go
- Homepage:
- Size: 26.4 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GH-SARIF
Interact with Code Scanning analysis and SARIF files.
`gh-sarif` is a [GitHub CLI](https://github.com/cli/cli) extension.
## Installation
```sh
gh extension install bagtoad/gh-sarif
```
## Usage
```
Usage:
gh sarif [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
delete Delete a GitHub Code Scanning Analysis
help Help about any command
list List GitHub Code Scanning analyses for a repository
upload Upload a SARIF file to GitHub Code Scanning
view View GitHub Code Scanning analysis or SARIF results
Flags:
-h, --help help for gh-sarif
-j, --json Output JSON instead of text (includes additional fields)
-R, --repo string GitHub repository (format: owner/repo)
Use "gh sarif [command] --help" for more information about a command.
```
### List Analyses for a Repository
```sh
gh sarif list
```
### View Analysis Results in a Table
```sh
gh sarif view
```
### View Analysis Results as SARIF
```sh
gh sarif view --sarif
```
### View Analysis Results as CSV
```sh
gh sarif view --csv
```
### View Analysis Results from a Local SARIF File
```sh
gh sarif view
```
### Upload a SARIF File to GitHub Code Scanning
```sh
gh sarif upload
```
### Delete an Analysis
```sh
gh sarif delete
```
### Delete Multiple Analyses
```sh
gh sarif delete ...
```
### Delete All Analyses in the set Except the Last
```sh
gh sarif delete --delete-all
```
### Delete All Analyses in the set, Including the Last
```sh
gh sarif delete --delete-all --confirm-delete
```
or
```sh
gh sarif delete --purge
```