Skip to content

Commit

Permalink
Auto-generated cli documentation update - 2024-07-12 10:25:04 (#3872)
Browse files Browse the repository at this point in the history
Update documentation

Co-authored-by: dmjb <dmjb@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and dmjb authored Jul 12, 2024
1 parent 4eb788e commit 6e4e319
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/docs/ref/cli/minder.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ https://docs.stacklok.com/minder
* [minder auth](minder_auth.md) - Authorize and manage accounts within a minder control plane
* [minder completion](minder_completion.md) - Generate the autocompletion script for the specified shell
* [minder docs](minder_docs.md) - Generates documentation for the client
* [minder history](minder_history.md) - View evaluation history
* [minder profile](minder_profile.md) - Manage profiles
* [minder project](minder_project.md) - Manage project within a minder control plane
* [minder provider](minder_provider.md) - Manage providers within a minder control plane
Expand Down
39 changes: 39 additions & 0 deletions docs/docs/ref/cli/minder_history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: minder history
---
## minder history

View evaluation history

### Synopsis

The history subcommands allows evaluation history to be viewed.

```
minder history [flags]
```

### Options

```
-h, --help help for history
-o, --output string Output format (one of json,yaml,table) (default "table")
-j, --project string ID of the project
```

### Options inherited from parent commands

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
```

### SEE ALSO

* [minder](minder.md) - Minder controls the hosted minder service
* [minder history list](minder_history_list.md) - List history

45 changes: 45 additions & 0 deletions docs/docs/ref/cli/minder_history_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: minder history list
---
## minder history list

List history

### Synopsis

The history list subcommand lets you list history within Minder.

```
minder history list [flags]
```

### Options

```
--alert-status string Filter evaluation history list by alert status - one of off, on, error, skipped, not_available
--entity-name string Filter evaluation history list by entity name
--entity-type string Filter evaluation history list by entity type - one of repository, artifact, pull_request
--eval-status string Filter evaluation history list by evaluation status - one of pending, failure, error, success, skipped
-h, --help help for list
--profile-name string Filter evaluation history list by profile name
--remediation-status string Filter evaluation history list by remediation status - one of failure, failure, error, success, skipped, not_available
--rule-name string Filter evaluation history list by rule name
```

### Options inherited from parent commands

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "api.stacklok.com")
--grpc-insecure Allow establishing insecure connections
--grpc-port int Server port (default 443)
--identity-client string Identity server client ID (default "minder-cli")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
-o, --output string Output format (one of json,yaml,table) (default "table")
-j, --project string ID of the project
```

### SEE ALSO

* [minder history](minder_history.md) - View evaluation history

0 comments on commit 6e4e319

Please sign in to comment.