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 Sep 13, 2023
1 parent 747293d commit d34dff0
Show file tree
Hide file tree
Showing 18 changed files with 248 additions and 881 deletions.
7 changes: 6 additions & 1 deletion docs/kratos/cli/kratos-cleanup-sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,19 @@ kratos cleanup sql <database-url> [flags]
### Options

```
-c, --config strings Path to one or more .json, .yaml, .yml, .toml config files. Values are loaded in the order provided, meaning that the last config file overwrites values from the previous config file.
-b, --database.cleanup.batch_size int Set the number of records to be cleaned per run (default 100)
--database.cleanup.sleep.tables duration How long to wait between each table cleanup (default 1m0s)
-h, --help help for sql
--keep-last duration Don't remove records younger than
-e, --read-from-env If set, reads the database connection string from the environment variable DSN or config file key dsn. (default true)
```

### Options inherited from parent commands

```
-c, --config strings Path to one or more .json, .yaml, .yml, .toml config files. Values are loaded in the order provided, meaning that the last config file overwrites values from the previous config file.
```

### SEE ALSO

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

### Options
Expand All @@ -41,7 +41,7 @@ To delete the identity with the recovery email address "[email protected]", run:

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-q, --quiet Be quiet with output printing.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Delete resources

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-h, --help help for delete
-q, --quiet Be quiet with output printing.
```
Expand Down
4 changes: 2 additions & 2 deletions docs/kratos/cli/kratos-get-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ kratos get identity [id-1] [id-2] [id-n] [flags]
```
To get the identities with the recovery email address at the domain "ory.sh", run:
kratos get identity $(kratos ls identities --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')
{{ .CommandPath }} $({{ .Root.Name }} ls identities --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')
```

### Options
Expand All @@ -42,7 +42,7 @@ To get the identities with the recovery email address at the domain "ory.sh", ru

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-q, --quiet Be quiet with output printing.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Get resources

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-h, --help help for get
-q, --quiet Be quiet with output printing.
```
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-hashers-argon2-calibrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ kratos hashers argon2 calibrate <requests-per-minute> [flags]
-c, --config strings Path to one or more .json, .yaml, .yml, .toml config files. Values are loaded in the order provided, meaning that the last config file overwrites values from the previous config file.
--dedicated-memory byte_size Amount of memory dedicated for password hashing. Kratos will try to not consume more memory. (default 1.00GB)
--expected-deviation duration Expected deviation of the time a hashing operation (~login request) takes. (default 500ms)
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-h, --help help for calibrate
--key-length uint32 Length of the key in bytes. (default 32)
--max-concurrent uint8 Maximum number of concurrent hashing operations. (default 16)
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-hashers-argon2-load-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ kratos hashers argon2 load-test <authentication-requests-per-minute> [flags]
-c, --config strings Path to one or more .json, .yaml, .yml, .toml config files. Values are loaded in the order provided, meaning that the last config file overwrites values from the previous config file.
--dedicated-memory byte_size Amount of memory dedicated for password hashing. Kratos will try to not consume more memory. (default 1.00GB)
--expected-deviation duration Expected deviation of the time a hashing operation (~login request) takes. (default 500ms)
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-h, --help help for load-test
--iterations uint32 Number of iterations to start probing at. (default 1)
--key-length uint32 Length of the key in bytes. (default 32)
Expand Down
6 changes: 3 additions & 3 deletions docs/kratos/cli/kratos-import-identities.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ Create an example identity:
}
EOF
kratos import identities file.json
{{ .CommandPath }} file.json
Alternatively:
cat file.json | kratos import identities
cat file.json | {{ .CommandPath }}
```

### Options
Expand All @@ -54,7 +54,7 @@ Alternatively:

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-q, --quiet Be quiet with output printing.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Import resources

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-h, --help help for import
-q, --quiet Be quiet with output printing.
```
Expand Down
12 changes: 5 additions & 7 deletions docs/kratos/cli/kratos-list-identities.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,29 @@ List identities

### Synopsis

Return a list of identities.
List identities (paginated)

```
kratos list identities [flags]
kratos list identities [<page> <per-page>] [flags]
```

### Examples

```
kratos list identities --page-size 100
{{ .CommandPath }} 100 1
```

### Options

```
-h, --help help for identities
--page-size int maximum number of items to return (default 100)
--page-token string page token acquired from a previous response
-h, --help help for identities
```

### Options inherited from parent commands

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-q, --quiet Be quiet with output printing.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ List resources

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-h, --help help for list
-q, --quiet Be quiet with output printing.
```
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-remote-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ kratos remote status [flags]

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-q, --quiet Be quiet with output printing.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-remote-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ kratos remote version [flags]

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-q, --quiet Be quiet with output printing.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-remote.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Helpers and management for remote Ory Kratos instances

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-h, --help help for remote
-q, --quiet Be quiet with output printing.
```
Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-validate-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ kratos validate identity file.json [file-2.json] [file-3.json] [file-n.json] [fl

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-q, --quiet Be quiet with output printing.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/kratos/cli/kratos-validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Validate resources

```
-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")
--format string Set the output format. One of table, json, yaml, and json-pretty. (default "default")
-h, --help help for validate
-q, --quiet Be quiet with output printing.
```
Expand Down
Loading

0 comments on commit d34dff0

Please sign in to comment.