Skip to content

Commit

Permalink
Auto-generated cli documentation update - 2023-11-16 17:40:44 (#1683)
Browse files Browse the repository at this point in the history
Update documentation

Co-authored-by: rdimitrov <[email protected]>
  • Loading branch information
github-actions[bot] and rdimitrov authored Nov 16, 2023
1 parent 453e582 commit 59e7925
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 5 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 @@ -32,6 +32,7 @@ https://docs.stacklok.com/minder
* [minder profile](minder_profile.md) - Manage profiles within a minder control plane
* [minder profile_status](minder_profile_status.md) - Manage profile status within a minder control plane
* [minder provider](minder_provider.md) - Manage providers within a minder control plane
* [minder quickstart](minder_quickstart.md) - Quickstart minder
* [minder repo](minder_repo.md) - Manage repositories within a minder control plane
* [minder rule_type](minder_rule_type.md) - Manage rule types within a minder control plane
* [minder version](minder_version.md) - Print the version of the minder CLI
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/ref/cli/minder_provider_enroll.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ minder provider enroll [flags]
### Options

```
-h, --help help for enroll
-o, --owner string Owner to filter on for provider resources
-g, --project-id string ID of the project for enrolling the provider
-p, --provider string Name for the provider to enroll
-t, --token string Personal Access Token (PAT) to use for enrollment
-h, --help help for enroll
-o, --owner string Owner to filter on for provider resources
-r, --project string ID of the project for enrolling the provider
-p, --provider string Name for the provider to enroll
-t, --token string Personal Access Token (PAT) to use for enrollment
```

### Options inherited from parent commands
Expand Down
41 changes: 41 additions & 0 deletions docs/docs/ref/cli/minder_quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: minder quickstart
---
## minder quickstart

Quickstart minder

### Synopsis

The quickstart command provide the means to quickly get started with minder

```
minder quickstart [flags]
```

### Options

```
-h, --help help for quickstart
-o, --owner string Owner to filter on for provider resources
-r, --project string Project to create the quickstart profile in
-p, --provider string Name of the provider (default "github")
-t, --token string Personal Access Token (PAT) to use for enrollment
```

### 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-realm string Identity server realm (default "stacklok")
--identity-url string Identity server issuer URL (default "https://auth.stacklok.com")
```

### SEE ALSO

* [minder](minder.md) - Minder controls the hosted minder service

0 comments on commit 59e7925

Please sign in to comment.