Skip to content

Commit

Permalink
Auto-generated cli documentation update - 2023-11-03 19:12:00 (#1444)
Browse files Browse the repository at this point in the history
Update documentation

Co-authored-by: JAORMX <[email protected]>
  • Loading branch information
github-actions[bot] and JAORMX authored Nov 3, 2023
1 parent e095aa3 commit 1c8c8c4
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/docs/ref/cli/commands/minder_rule_type.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@ minder rule_type [flags]
### SEE ALSO

* [minder](minder.md) - Minder controls the hosted minder service
* [minder rule_type apply](minder_rule_type_apply.md) - Apply a rule type within a minder control plane
* [minder rule_type create](minder_rule_type_create.md) - Create a rule type within a minder control plane
* [minder rule_type delete](minder_rule_type_delete.md) - Delete a rule type
* [minder rule_type get](minder_rule_type_get.md) - Get details for a rule type within a minder control plane
* [minder rule_type list](minder_rule_type_list.md) - List rule types within a minder control plane
* [minder rule_type update](minder_rule_type_update.md) - Update a rule type within a minder control plane

39 changes: 39 additions & 0 deletions docs/docs/ref/cli/commands/minder_rule_type_apply.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: minder rule type apply
---
## minder rule_type apply

Apply a rule type within a minder control plane

### Synopsis

The minder rule type apply subcommand lets you create or update rule types for a project
within a minder control plane.

```
minder rule_type apply [flags]
```

### Options

```
-f, --file stringArray Path to the YAML defining the rule type (or - for stdin). Can be specified multiple times. Can be a directory.
-h, --help help for apply
```

### Options inherited from parent commands

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "staging.stacklok.dev")
--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.staging.stacklok.dev")
```

### SEE ALSO

* [minder rule_type](minder_rule_type.md) - Manage rule types within a minder control plane

2 changes: 1 addition & 1 deletion docs/docs/ref/cli/commands/minder_rule_type_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Create a rule type within a minder control plane

### Synopsis

The minder rule type create subcommand lets you create new profiles for a project
The minder rule type create subcommand lets you create new rule types for a project
within a minder control plane.

```
Expand Down
39 changes: 39 additions & 0 deletions docs/docs/ref/cli/commands/minder_rule_type_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: minder rule type update
---
## minder rule_type update

Update a rule type within a minder control plane

### Synopsis

The minder rule type update subcommand lets you update rule types for a project
within a minder control plane.

```
minder rule_type update [flags]
```

### Options

```
-f, --file stringArray Path to the YAML defining the rule type (or - for stdin). Can be specified multiple times. Can be a directory.
-h, --help help for update
```

### Options inherited from parent commands

```
--config string Config file (default is $PWD/config.yaml)
--grpc-host string Server host (default "staging.stacklok.dev")
--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.staging.stacklok.dev")
```

### SEE ALSO

* [minder rule_type](minder_rule_type.md) - Manage rule types within a minder control plane

0 comments on commit 1c8c8c4

Please sign in to comment.