From 6e4e31928f293530f5441623fe6b13a470fb9129 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 12 Jul 2024 10:31:42 +0100 Subject: [PATCH] Auto-generated cli documentation update - 2024-07-12 10:25:04 (#3872) Update documentation Co-authored-by: dmjb --- docs/docs/ref/cli/minder.md | 1 + docs/docs/ref/cli/minder_history.md | 39 ++++++++++++++++++++ docs/docs/ref/cli/minder_history_list.md | 45 ++++++++++++++++++++++++ 3 files changed, 85 insertions(+) create mode 100644 docs/docs/ref/cli/minder_history.md create mode 100644 docs/docs/ref/cli/minder_history_list.md diff --git a/docs/docs/ref/cli/minder.md b/docs/docs/ref/cli/minder.md index 6a92775753..d74410d38e 100644 --- a/docs/docs/ref/cli/minder.md +++ b/docs/docs/ref/cli/minder.md @@ -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 diff --git a/docs/docs/ref/cli/minder_history.md b/docs/docs/ref/cli/minder_history.md new file mode 100644 index 0000000000..826c6a18f8 --- /dev/null +++ b/docs/docs/ref/cli/minder_history.md @@ -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 + diff --git a/docs/docs/ref/cli/minder_history_list.md b/docs/docs/ref/cli/minder_history_list.md new file mode 100644 index 0000000000..c496574d33 --- /dev/null +++ b/docs/docs/ref/cli/minder_history_list.md @@ -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 +