Skip to content

Commit a0b51fb

Browse files
committed
autogen(docs): generate cli docs
1 parent dbb21b6 commit a0b51fb

17 files changed

+803
-263
lines changed

docs/kratos/cli/kratos-delete-identity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ kratos delete identity id-0 [id-1] [id-2] [id-n] [flags]
2828
```
2929
To delete the identity with the recovery email address "[email protected]", run:
3030
31-
{{ .CommandPath }} $({{ .Root.Name }} list identities --format json | jq -r 'map(select(.recovery_addresses[].value == "[email protected]")) | .[].id')
31+
kratos delete identity $(kratos list identities --format json | jq -r 'map(select(.recovery_addresses[].value == "[email protected]")) | .[].id')
3232
```
3333

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

4242
```
4343
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
44-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
44+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
4545
-q, --quiet Be quiet with output printing.
4646
```
4747

docs/kratos/cli/kratos-delete.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Delete resources
1717

1818
```
1919
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
20-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
20+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
2121
-h, --help help for delete
2222
-q, --quiet Be quiet with output printing.
2323
```

docs/kratos/cli/kratos-get-identity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ kratos get identity [id-1] [id-2] [id-n] [flags]
2828
```
2929
To get the identities with the recovery email address at the domain "ory.sh", run:
3030
31-
{{ .CommandPath }} $({{ .Root.Name }} ls identities --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')
31+
kratos get identity $(kratos ls identities --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')
3232
```
3333

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

4343
```
4444
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
45-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
45+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
4646
-q, --quiet Be quiet with output printing.
4747
```
4848

docs/kratos/cli/kratos-get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Get resources
1717

1818
```
1919
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
20-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
20+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
2121
-h, --help help for get
2222
-q, --quiet Be quiet with output printing.
2323
```

docs/kratos/cli/kratos-hashers-argon2-calibrate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ kratos hashers argon2 calibrate <requests-per-minute> [flags]
3232
-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.
3333
--dedicated-memory byte_size Amount of memory dedicated for password hashing. Kratos will try to not consume more memory. (default 1.00GB)
3434
--expected-deviation duration Expected deviation of the time a hashing operation (~login request) takes. (default 500ms)
35-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
35+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
3636
-h, --help help for calibrate
3737
--key-length uint32 Length of the key in bytes. (default 32)
3838
--max-concurrent uint8 Maximum number of concurrent hashing operations. (default 16)

docs/kratos/cli/kratos-hashers-argon2-load-test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ kratos hashers argon2 load-test <authentication-requests-per-minute> [flags]
2727
-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.
2828
--dedicated-memory byte_size Amount of memory dedicated for password hashing. Kratos will try to not consume more memory. (default 1.00GB)
2929
--expected-deviation duration Expected deviation of the time a hashing operation (~login request) takes. (default 500ms)
30-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
30+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
3131
-h, --help help for load-test
3232
--iterations uint32 Number of iterations to start probing at. (default 1)
3333
--key-length uint32 Length of the key in bytes. (default 32)

docs/kratos/cli/kratos-import-identities.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Create an example identity:
3737
}
3838
EOF
3939
40-
{{ .CommandPath }} file.json
40+
kratos import identities file.json
4141
4242
Alternatively:
4343
44-
cat file.json | {{ .CommandPath }}
44+
cat file.json | kratos import identities
4545
```
4646

4747
### Options
@@ -54,7 +54,7 @@ Alternatively:
5454

5555
```
5656
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
57-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
57+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
5858
-q, --quiet Be quiet with output printing.
5959
```
6060

docs/kratos/cli/kratos-import.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Import resources
1717

1818
```
1919
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
20-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
20+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
2121
-h, --help help for import
2222
-q, --quiet Be quiet with output printing.
2323
```

docs/kratos/cli/kratos-list-identities.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,31 @@ List identities
1515

1616
### Synopsis
1717

18-
List identities (paginated)
18+
Return a list of identities.
1919

2020
```
21-
kratos list identities [<page> <per-page>] [flags]
21+
kratos list identities [flags]
2222
```
2323

2424
### Examples
2525

2626
```
27-
{{ .CommandPath }} 100 1
27+
kratos list identities --page-size 100
2828
```
2929

3030
### Options
3131

3232
```
33-
-h, --help help for identities
33+
-h, --help help for identities
34+
--page-size int maximum number of items to return (default 100)
35+
--page-token string page token acquired from a previous response
3436
```
3537

3638
### Options inherited from parent commands
3739

3840
```
3941
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
40-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
42+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
4143
-q, --quiet Be quiet with output printing.
4244
```
4345

docs/kratos/cli/kratos-list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ List resources
1717

1818
```
1919
-e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable.
20-
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
20+
--format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default")
2121
-h, --help help for list
2222
-q, --quiet Be quiet with output printing.
2323
```

0 commit comments

Comments
 (0)