Skip to content

Commit

Permalink
autogen(docs): generate cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ory-bot committed Jan 8, 2024
1 parent b20642d commit fb7acce
Show file tree
Hide file tree
Showing 57 changed files with 181 additions and 144 deletions.
2 changes: 1 addition & 1 deletion docs/cli/ory-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ ory auth [flags]

```
-c, --config string Path to the Ory Network configuration file.
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for auth
-q, --quiet Be quiet with output printing.
-y, --yes Confirm all dialogs with yes.
Expand Down
16 changes: 9 additions & 7 deletions docs/cli/ory-create-jwk.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,20 @@ ory create jwk <set-id> [<key-id>] [flags]
### Examples

```
{{ .CommandPath }} <my-jwk-set> --alg RS256 --use sig
ory create jwk <my-jwk-set> --alg RS256 --use sig
```

### Options

```
--alg string The algorithm to be used to generated they key. Supports: RS256, RS512, ES256, ES512, EdDSA (default "RS256")
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-h, --help help for jwk
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
--use string The intended use of this key. Supports: sig, enc (default "sig")
--alg string The algorithm to be used to generated they key. Supports: RS256, RS512, ES256, ES512, EdDSA (default "RS256")
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for jwk
--project string The project to use, either project ID or a (partial) slug.
--public Only return public keys
-q, --quiet Be quiet with output printing.
--use string The intended use of this key. Supports: sig, enc (default "sig")
```

### Options inherited from parent commands
Expand Down
10 changes: 6 additions & 4 deletions docs/cli/ory-create-oauth2-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ the Authorize Code, Implicit, Refresh flow. This command allows settings all fie

To encrypt an auto-generated OAuth2 Client Secret, use flags `--pgp-key`, `--pgp-key-url` or `--keybase` flag, for example:

{{ .CommandPath }} -n "my app" -g client_credentials -r token -a core,foobar --keybase keybase_username
ory create oauth2-client -n "my app" -g client_credentials -r token -a core,foobar --keybase keybase_username


```
Expand All @@ -30,11 +30,11 @@ ory create oauth2-client [flags]
### Examples

```
{{ .CommandPath }} -n "my app" -c http://localhost/cb -g authorization_code -r code -a core,foobar
ory create oauth2-client -n "my app" -c http://localhost/cb -g authorization_code -r code -a core,foobar
Use the tool jq (or any other JSON tool) to get the OAuth2 Client ID and and Secret:
client=$({{ .CommandPath }} \
client=$(ory create oauth2-client \
--format json \
...)
echo $client
Expand All @@ -53,7 +53,8 @@ client_secret=$(echo $client | jq -r '.client_secret')
--backchannel-logout-session-required Boolean flag specifying whether the client requires that a sid (session ID) Claim be included in the Logout Token to identify the client session with the OP when the backchannel-logout-callback is used. If omitted, the default value is false.
--client-uri string A URL string of a web page providing information about the client
--contact strings A list representing ways to contact people responsible for this client, typically email addresses.
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
--frontchannel-logout-callback string Client URL that will cause the client to log itself out when rendered in an iframe by Hydra.
--frontchannel-logout-session-required Boolean flag specifying whether the client requires that a sid (session ID) Claim be included in the Logout Token to identify the client session with the OP when the frontchannel-logout-callback is used. If omitted, the default value is false.
--grant-type strings A list of allowed grant types. (default [authorization_code])
Expand All @@ -77,6 +78,7 @@ client_secret=$(echo $client | jq -r '.client_secret')
--scope strings The scope the client is allowed to request.
--secret string Provide the client's secret.
--sector-identifier-uri string URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values.
--skip-consent Boolean flag specifying whether to skip the consent screen for this client. If omitted, the default value is false.
--subject-type public A identifier algorithm. Valid values are public and `pairwise`. (default "public")
--token-endpoint-auth-method client_secret_post Define which authentication method the client may use at the Token Endpoint. Valid values are client_secret_post, `client_secret_basic`, `private_key_jwt`, and `none`. (default "client_secret_basic")
--tos-uri string A URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/ory-create-organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ ory create organization label [--project=PROJECT_ID] [--domains=a.example.com,b.

```
-d, --domains strings A list of domains that will be used for this organization.
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for organization
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/ory-create-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ ory create project [flags]
### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for project
-n, --name string The name of the project, required when quiet mode is used
-q, --quiet Be quiet with output printing.
Expand Down
18 changes: 10 additions & 8 deletions docs/cli/ory-create-relationships.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: ory-create-relationships
title: ory create relationships
description: ory create relationships Create relation tuples from JSON files
description: ory create relationships Create relationships from JSON files
---

<!--
Expand All @@ -11,12 +11,12 @@ To improve this file please make your change against the appropriate "./cmd/*.go
-->
## ory create relationships

Create relation tuples from JSON files
Create relationships from JSON files

### Synopsis

Create relation tuples from JSON files.
A directory will be traversed and all relation tuples will be created.
Create relationships from JSON files.
A directory will be traversed and all relationships will be created.
Pass the special filename `-` to read from STD_IN.

```
Expand All @@ -26,10 +26,12 @@ ory create relationships [flags]
### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-h, --help help for relationships
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
--authority string Set the authority header for the remote gRPC server.
--block Block until the connection is up.
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for relationships
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/ory-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Create Ory Network resources

```
-c, --config string Path to the Ory Network configuration file.
--format string Set the output format. One of default, json, yaml, json-pretty and jsonpath. (default "default")
--format string Set the output format. One of default, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for create
-q, --quiet Be quiet with output printing.
-y, --yes Confirm all dialogs with yes.
Expand All @@ -30,5 +30,5 @@ Create Ory Network resources
* [ory create oauth2-client](ory-create-oauth2-client) - Create an OAuth 2.0 Client
* [ory create organization](ory-create-organization) - Create a new Ory Network organization
* [ory create project](ory-create-project) - Create a new Ory Network project
* [ory create relationships](ory-create-relationships) - Create relation tuples from JSON files
* [ory create relationships](ory-create-relationships) - Create relationships from JSON files

11 changes: 6 additions & 5 deletions docs/cli/ory-delete-access-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,17 @@ ory delete access-tokens <client-id> [flags]
### Examples

```
{{ .CommandPath }} <client-id>
ory delete access-tokens <client-id>
```

### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-h, --help help for access-tokens
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for access-tokens
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/ory-delete-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ ory delete identity id-0 [id-1] [id-2] [id-n] [flags]
```
To delete the identity with the recovery email address "[email protected]", run:
{{ .CommandPath }} $({{ .Root.Name }} list identities --format json | jq -r 'map(select(.recovery_addresses[].value == "[email protected]")) | .[].id')
ory delete identity $(ory list identities --format json | jq -r 'map(select(.recovery_addresses[].value == "[email protected]")) | .[].id')
```

### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for identity
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
Expand Down
11 changes: 6 additions & 5 deletions docs/cli/ory-delete-jwk.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,17 @@ ory delete jwk <id-1> [<id-2> ...] [flags]
### Examples

```
{{ .CommandPath }} <set-1> <set-2> <set-3>
ory delete jwk <set-1> <set-2> <set-3>
```

### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-h, --help help for jwk
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for jwk
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
```

### Options inherited from parent commands
Expand Down
13 changes: 7 additions & 6 deletions docs/cli/ory-delete-oauth2-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,21 @@ ory delete oauth2-client <id-1> [<id-2> ...] [flags]
### Examples

```
{{ .CommandPath }} <client-1> <client-2> <client-3>
ory delete oauth2-client <client-1> <client-2> <client-3>
To delete OAuth 2.0 Clients with the owner of "[email protected]", run:
{{ .CommandPath }} $({{ .Root.Name }} list oauth2-clients --format json | jq -r 'map(select(.contacts[] == "[email protected]")) | .[].client_id')
ory delete oauth2-client $(ory list oauth2-clients --format json | jq -r 'map(select(.contacts[] == "[email protected]")) | .[].client_id')
```

### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-h, --help help for oauth2-client
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for oauth2-client
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/ory-delete-organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ ory delete organization id [--project=PROJECT_ID] [flags]

```
-c, --config string Path to the Ory Network configuration file.
--format string Set the output format. One of default, json, yaml, json-pretty and jsonpath. (default "default")
--format string Set the output format. One of default, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-q, --quiet Be quiet with output printing.
-y, --yes Confirm all dialogs with yes.
```
Expand Down
12 changes: 7 additions & 5 deletions docs/cli/ory-delete-relationships.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: ory-delete-relationships
title: ory delete relationships
description: ory delete relationships Delete ALL relation tuples matching the relation query.
description: ory delete relationships Delete ALL relationships matching the relation query.
---

<!--
Expand All @@ -11,11 +11,11 @@ To improve this file please make your change against the appropriate "./cmd/*.go
-->
## ory delete relationships

Delete ALL relation tuples matching the relation query.
Delete ALL relationships matching the relation query.

### Synopsis

Delete all relation tuples matching the relation query.
Delete all relationships matching the relation query.
It is recommended to first run the command without the `--force` flag to verify that the operation is safe.

```
Expand All @@ -26,8 +26,10 @@ ory delete relationships [flags]

```
--all Delete all relation tuples
--force Force the deletion of relation tuples
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
--authority string Set the authority header for the remote gRPC server.
--block Block until the connection is up.
--force Force the deletion of relationships
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for relationships
--namespace string Set the requested namespace
--object string Set the requested object
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/ory-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Delete resources

```
-c, --config string Path to the Ory Network configuration file.
--format string Set the output format. One of default, json, yaml, json-pretty and jsonpath. (default "default")
--format string Set the output format. One of default, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for delete
-q, --quiet Be quiet with output printing.
-y, --yes Confirm all dialogs with yes.
Expand All @@ -31,5 +31,5 @@ Delete resources
* [ory delete jwk](ory-delete-jwk) - Delete one or more JSON Web Key Sets by their set ID
* [ory delete oauth2-client](ory-delete-oauth2-client) - Delete one or more OAuth 2.0 Clients by their ID(s)
* [ory delete organization](ory-delete-organization) - Delete the organization with the given ID
* [ory delete relationships](ory-delete-relationships) - Delete ALL relation tuples matching the relation query.
* [ory delete relationships](ory-delete-relationships) - Delete ALL relationships matching the relation query.

2 changes: 1 addition & 1 deletion docs/cli/ory-get-identity-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ $ ory get identity-config ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 --format json
### Options

```
--format string Set the output format. One of default, json, yaml, json-pretty and jsonpath. (default "default")
--format string Set the output format. One of default, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for identity-config
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/ory-get-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ ory get identity [id-1] [id-2] [id-n] [flags]
```
To get the identities with the recovery email address at the domain "ory.sh", run:
{{ .CommandPath }} $({{ .Root.Name }} ls identities --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')
ory get identity $(ory ls identities --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')
```

### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for identity
-i, --include-credentials stringArray Include third party tokens (only "oidc" supported)
--project string The project to use, either project ID or a (partial) slug.
Expand Down
19 changes: 13 additions & 6 deletions docs/cli/ory-get-jwk.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,25 @@ ory get jwk set-1 [set-2] ... [flags]
### Examples

```
To get the JSON Web Key Set's secret, run:
To get the JSON Web Key Set's use, run:
ory get jwk <set-id> | jq -r '.[].use'
To get the JSON Web Key Set as only public keys:
ory get jwk --public <set-id>'
{{ .CommandPath }} <set-id> | jq -r '.[].use'
```

### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-h, --help help for jwk
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
-h, --help help for jwk
--project string The project to use, either project ID or a (partial) slug.
--public Only return public keys
-q, --quiet Be quiet with output printing.
```

### Options inherited from parent commands
Expand Down
Loading

0 comments on commit fb7acce

Please sign in to comment.