Skip to content

Commit

Permalink
fix: resolve clidoc generation issue
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Oct 19, 2021
1 parent 990a39b commit 1aaaa03
Show file tree
Hide file tree
Showing 27 changed files with 152 additions and 209 deletions.
5 changes: 2 additions & 3 deletions docs/docs/cli/kratos-courier-watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos courier watch

Starts the Ory Kratos message courier
Expand All @@ -33,5 +32,5 @@ kratos courier watch [flags]

### SEE ALSO

- [kratos courier](kratos-courier) - Commands related to the Ory Kratos message
courier
* [kratos courier](kratos-courier) - Commands related to the Ory Kratos message courier

7 changes: 3 additions & 4 deletions docs/docs/cli/kratos-courier.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos courier

Commands related to the Ory Kratos message courier
Expand All @@ -23,6 +22,6 @@ Commands related to the Ory Kratos message courier

### SEE ALSO

- [kratos](kratos) -
- [kratos courier watch](kratos-courier-watch) - Starts the Ory Kratos message
courier
* [kratos](kratos) -
* [kratos courier watch](kratos-courier-watch) - Starts the Ory Kratos message courier

19 changes: 6 additions & 13 deletions docs/docs/cli/kratos-hashers-argon2-calibrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,17 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos hashers argon2 calibrate

Computes Optimal Argon2 Parameters

### Synopsis

This command helps you calibrate the configuration parameters for Argon2.
Password hashing is a trade-off between security, resource consumption, and user
experience. Resource consumption should not be too high and the login should not
take too long.
This command helps you calibrate the configuration parameters for Argon2. Password hashing is a trade-off between security, resource consumption, and user experience. Resource consumption should not be too high and the login should not take too long.

We recommend that the login process takes between half a second and one second
for password hashing, giving a good balance between security and user
experience.
We recommend that the login process takes between half a second and one second for password hashing, giving a good balance between security and user experience.

Please note that the values depend on the machine you run the hashing on. If you
have RAM constraints, please set the memory dedicated to Ory Kratos to avoid out
of memory panics.
Please note that the values depend on the machine you run the hashing on. If you have RAM constraints, please set the memory dedicated to Ory Kratos to avoid out of memory panics.

```
kratos hashers argon2 calibrate <requests-per-minute> [flags]
Expand All @@ -46,7 +38,7 @@ kratos hashers argon2 calibrate <requests-per-minute> [flags]
--max-concurrent uint8 Maximum number of concurrent hashing operations. (default 16)
--max-memory byte_size Maximum memory allowed (0 means no limit). (default 0.00B)
--min-duration duration Minimal duration a hashing operation (~login request) takes. (default 500ms)
--parallelism uint8 Number of threads to use. (default 96)
--parallelism uint8 Number of threads to use. (default 32)
-r, --probe-runs int Runs per probe, median of all runs is taken as the result. (default 2)
-q, --quiet Be quiet with output printing.
--salt-length uint32 Length of the salt in bytes. (default 16)
Expand All @@ -56,4 +48,5 @@ kratos hashers argon2 calibrate <requests-per-minute> [flags]

### SEE ALSO

- [kratos hashers argon2](kratos-hashers-argon2) -
* [kratos hashers argon2](kratos-hashers-argon2) -

10 changes: 4 additions & 6 deletions docs/docs/cli/kratos-hashers-argon2-hash.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
---
id: kratos-hashers-argon2-hash
title: kratos hashers argon2 hash
description:
kratos hashers argon2 hash Hash a list of passwords for benchmarking the
hashing parameters
description: kratos hashers argon2 hash Hash a list of passwords for benchmarking the hashing parameters
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos hashers argon2 hash

Hash a list of passwords for benchmarking the hashing parameters
Expand All @@ -32,10 +29,11 @@ kratos hashers argon2 hash &lt;password1&gt; [&lt;password2&gt; ...] [flags]
--memory byte_size Memory to use. (default 128.00MB)
--min-duration duration Minimal duration a hashing operation (~login request) takes. (default 500ms)
--parallel Run all hashing operations in parallel.
--parallelism uint8 Number of threads to use. (default 96)
--parallelism uint8 Number of threads to use. (default 32)
--salt-length uint32 Length of the salt in bytes. (default 16)
```

### SEE ALSO

- [kratos hashers argon2](kratos-hashers-argon2) -
* [kratos hashers argon2](kratos-hashers-argon2) -

14 changes: 5 additions & 9 deletions docs/docs/cli/kratos-hashers-argon2-load-test.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,21 @@
---
id: kratos-hashers-argon2-load-test
title: kratos hashers argon2 load-test
description:
kratos hashers argon2 load-test Simulate the password hashing with a number of
concurrent requests/minute.
description: kratos hashers argon2 load-test Simulate the password hashing with a number of concurrent requests/minute.
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos hashers argon2 load-test

Simulate the password hashing with a number of concurrent requests/minute.

### Synopsis

Simulates a number of concurrent authentication requests per minute. Gives
statistical data about the measured performance and resource consumption. Can be
used to tune and test the hashing parameters for peak demand situations.
Simulates a number of concurrent authentication requests per minute. Gives statistical data about the measured performance and resource consumption. Can be used to tune and test the hashing parameters for peak demand situations.

```
kratos hashers argon2 load-test &lt;authentication-requests-per-minute&gt; [flags]
Expand All @@ -38,11 +33,12 @@ kratos hashers argon2 load-test &lt;authentication-requests-per-minute&gt; [flag
--key-length uint32 Length of the key in bytes. (default 32)
--memory byte_size Memory to use. (default 128.00MB)
--min-duration duration Minimal duration a hashing operation (~login request) takes. (default 500ms)
--parallelism uint8 Number of threads to use. (default 96)
--parallelism uint8 Number of threads to use. (default 32)
-q, --quiet Be quiet with output printing.
--salt-length uint32 Length of the salt in bytes. (default 16)
```

### SEE ALSO

- [kratos hashers argon2](kratos-hashers-argon2) -
* [kratos hashers argon2](kratos-hashers-argon2) -

18 changes: 8 additions & 10 deletions docs/docs/cli/kratos-hashers-argon2.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
---
id: kratos-hashers-argon2
title: kratos hashers argon2
description: kratos hashers argon2
description: kratos hashers argon2
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos hashers argon2



### Options

```
Expand All @@ -20,11 +21,8 @@ To improve this file please make your change against the appropriate "./cmd/*.go

### SEE ALSO

- [kratos hashers](kratos-hashers) - This command contains helpers around
hashing
- [kratos hashers argon2 calibrate](kratos-hashers-argon2-calibrate) - Computes
Optimal Argon2 Parameters
- [kratos hashers argon2 hash](kratos-hashers-argon2-hash) - Hash a list of
passwords for benchmarking the hashing parameters
- [kratos hashers argon2 load-test](kratos-hashers-argon2-load-test) - Simulate
the password hashing with a number of concurrent requests/minute.
* [kratos hashers](kratos-hashers) - This command contains helpers around hashing
* [kratos hashers argon2 calibrate](kratos-hashers-argon2-calibrate) - Computes Optimal Argon2 Parameters
* [kratos hashers argon2 hash](kratos-hashers-argon2-hash) - Hash a list of passwords for benchmarking the hashing parameters
* [kratos hashers argon2 load-test](kratos-hashers-argon2-load-test) - Simulate the password hashing with a number of concurrent requests/minute.

6 changes: 3 additions & 3 deletions docs/docs/cli/kratos-hashers.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos hashers

This command contains helpers around hashing
Expand All @@ -22,5 +21,6 @@ This command contains helpers around hashing

### SEE ALSO

- [kratos](kratos) -
- [kratos hashers argon2](kratos-hashers-argon2) -
* [kratos](kratos) -
* [kratos hashers argon2](kratos-hashers-argon2) -

14 changes: 5 additions & 9 deletions docs/docs/cli/kratos-identities-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,16 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos identities delete

Delete identities by ID

### Synopsis

This command deletes one or more identities by ID. To delete an identity by some
selector, e.g. the recovery email address, use the list command in combination
with jq.
This command deletes one or more identities by ID. To delete an identity by some selector, e.g. the recovery email address, use the list command in combination with jq.

We have to admit, this is not easy if you don&#39;t speak jq fluently. What about opening an issue and telling us what predefined selectors you want to have? https://github.com/ory/kratos/issues/new/choose

We have to admit, this is not easy if you don&#39;t speak jq fluently. What
about opening an issue and telling us what predefined selectors you want to
have? https://github.com/ory/kratos/issues/new/choose

```
kratos identities delete &lt;id-0 [id-1 ...]&gt; [flags]
Expand Down Expand Up @@ -52,5 +48,5 @@ To delete the identity with the recovery email address &#34;foo@bar.com&#34;, ru

### SEE ALSO

- [kratos identities](kratos-identities) - Tools to interact with remote
identities
* [kratos identities](kratos-identities) - Tools to interact with remote identities

14 changes: 5 additions & 9 deletions docs/docs/cli/kratos-identities-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,16 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos identities get

Get one or more identities by ID

### Synopsis

This command gets all the details about an identity. To get an identity by some
selector, e.g. the recovery email address, use the list command in combination
with jq.
This command gets all the details about an identity. To get an identity by some selector, e.g. the recovery email address, use the list command in combination with jq.

We have to admit, this is not easy if you don&#39;t speak jq fluently. What about opening an issue and telling us what predefined selectors you want to have? https://github.com/ory/kratos/issues/new/choose

We have to admit, this is not easy if you don&#39;t speak jq fluently. What
about opening an issue and telling us what predefined selectors you want to
have? https://github.com/ory/kratos/issues/new/choose

```
kratos identities get &lt;id-0 [id-1 ...]&gt; [flags]
Expand Down Expand Up @@ -52,5 +48,5 @@ To get the identities with the recovery email address at the domain &#34;ory.sh&

### SEE ALSO

- [kratos identities](kratos-identities) - Tools to interact with remote
identities
* [kratos identities](kratos-identities) - Tools to interact with remote identities

8 changes: 3 additions & 5 deletions docs/docs/cli/kratos-identities-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos identities import

Import identities from files or STD_IN
Expand All @@ -18,8 +17,7 @@ Import identities from files or STD_IN

Import identities from files or STD_IN.

Files can contain only a single or an array of identities. The validity of files
can be tested beforehand using &#34;... identities validate&#34;.
Files can contain only a single or an array of identities. The validity of files can be tested beforehand using &#34;... identities validate&#34;.

WARNING: Importing credentials is not yet supported.

Expand Down Expand Up @@ -60,5 +58,5 @@ $ cat file.json | kratos identities import

### SEE ALSO

- [kratos identities](kratos-identities) - Tools to interact with remote
identities
* [kratos identities](kratos-identities) - Tools to interact with remote identities

5 changes: 2 additions & 3 deletions docs/docs/cli/kratos-identities-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos identities list

List identities
Expand Down Expand Up @@ -38,5 +37,5 @@ kratos identities list [&lt;page&gt; &lt;per-page&gt;] [flags]

### SEE ALSO

- [kratos identities](kratos-identities) - Tools to interact with remote
identities
* [kratos identities](kratos-identities) - Tools to interact with remote identities

8 changes: 3 additions & 5 deletions docs/docs/cli/kratos-identities-patch.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
id: kratos-identities-patch
title: kratos identities patch
description:
kratos identities patch Patch identities by ID (not yet implemented)
description: kratos identities patch Patch identities by ID (not yet implemented)
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos identities patch

Patch identities by ID (not yet implemented)
Expand All @@ -35,5 +33,5 @@ kratos identities patch &lt;file.json [file-2.json [file-3.json] ...]&gt; [flags

### SEE ALSO

- [kratos identities](kratos-identities) - Tools to interact with remote
identities
* [kratos identities](kratos-identities) - Tools to interact with remote identities

13 changes: 6 additions & 7 deletions docs/docs/cli/kratos-identities-validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,16 @@ This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->

## kratos identities validate

Validate local identity files

### Synopsis

This command allows validation of identity files. It validates against the
payload of the API and the identity schema as configured in Ory Kratos.
Identities can be supplied via STD_IN or JSON files containing a single or an
array of identities.
This command allows validation of identity files.
It validates against the payload of the API and the identity schema as configured in Ory Kratos.
Identities can be supplied via STD_IN or JSON files containing a single or an array of identities.


```
kratos identities validate &lt;file.json [file-2.json [file-3.json] ...]&gt; [flags]
Expand All @@ -41,5 +40,5 @@ kratos identities validate &lt;file.json [file-2.json [file-3.json] ...]&gt; [fl

### SEE ALSO

- [kratos identities](kratos-identities) - Tools to interact with remote
identities
* [kratos identities](kratos-identities) - Tools to interact with remote identities

0 comments on commit 1aaaa03

Please sign in to comment.