Skip to content

Commit f6ab4ff

Browse files
ory-botunatasha8
authored andcommitted
autogen(docs): generate cli docs
1 parent a04e06a commit f6ab4ff

29 files changed

+147
-129
lines changed

docs/kratos/cli/kratos-cleanup-sql.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-cleanup-sql
33
title: kratos cleanup sql
4-
description: kratos cleanup sql Cleanup sql database from expired flows and sessions
4+
description: kratos cleanup sql
55
---
66

77
<!--
@@ -19,8 +19,10 @@ Run this command as frequently as you need.
1919
It is recommended to run this command close to the SQL instance (e.g. same subnet) instead of over the public internet.
2020
This decreases risk of failure and decreases time required.
2121
You can read in the database URL using the -e flag, for example:
22-
export DSN=...
23-
kratos cleanup sql -e
22+
```
23+
export DSN=...
24+
kratos cleanup sql -e
25+
```
2426
### WARNING ###
2527
Before running this command on an existing database, create a back up!
2628

@@ -40,7 +42,7 @@ kratos cleanup sql <database-url> [flags]
4042
-e, --read-from-env If set, reads the database connection string from the environment variable DSN or config file key dsn. (default true)
4143
```
4244

43-
### SEE ALSO
45+
### See also
4446

45-
* [kratos cleanup](kratos-cleanup) - Various cleanup helpers
47+
* [kratos cleanup](kratos-cleanup) Various cleanup helpers
4648

docs/kratos/cli/kratos-cleanup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-cleanup
33
title: kratos cleanup
4-
description: kratos cleanup Various cleanup helpers
4+
description: kratos cleanup
55
---
66

77
<!--
@@ -20,8 +20,8 @@ Various cleanup helpers
2020
-h, --help help for cleanup
2121
```
2222

23-
### SEE ALSO
23+
### See also
2424

25-
* [kratos](kratos) -
25+
* [kratos](kratos)
2626
* [kratos cleanup sql](kratos-cleanup-sql) - Cleanup sql database from expired flows and sessions
2727

docs/kratos/cli/kratos-courier-watch.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-courier-watch
33
title: kratos courier watch
4-
description: kratos courier watch Starts the Ory Kratos message courier
4+
description: kratos courier watch
55
---
66

77
<!--
@@ -30,7 +30,7 @@ kratos courier watch [flags]
3030
-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.
3131
```
3232

33-
### SEE ALSO
33+
### See also
3434

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

docs/kratos/cli/kratos-courier.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-courier
33
title: kratos courier
4-
description: kratos courier Commands related to the Ory Kratos message courier
4+
description: kratos courier
55
---
66

77
<!--
@@ -20,8 +20,8 @@ Commands related to the Ory Kratos message courier
2020
-h, --help help for courier
2121
```
2222

23-
### SEE ALSO
23+
### See also
2424

25-
* [kratos](kratos) -
25+
* [kratos](kratos)
2626
* [kratos courier watch](kratos-courier-watch) - Starts the Ory Kratos message courier
2727

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-delete-identity
33
title: kratos delete identity
4-
description: kratos delete identity Delete one or more identities by their ID(s)
4+
description: kratos delete identity
55
---
66

77
<!--
@@ -45,7 +45,7 @@ To delete the identity with the recovery email address "foo@bar.com", run:
4545
-q, --quiet Be quiet with output printing.
4646
```
4747

48-
### SEE ALSO
48+
### See also
4949

50-
* [kratos delete](kratos-delete) - Delete resources
50+
* [kratos delete](kratos-delete) Delete resources
5151

docs/kratos/cli/kratos-delete.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-delete
33
title: kratos delete
4-
description: kratos delete Delete resources
4+
description: kratos delete
55
---
66

77
<!--
@@ -22,8 +22,8 @@ Delete resources
2222
-q, --quiet Be quiet with output printing.
2323
```
2424

25-
### SEE ALSO
25+
### See also
2626

27-
* [kratos](kratos) -
27+
* [kratos](kratos)
2828
* [kratos delete identity](kratos-delete-identity) - Delete one or more identities by their ID(s)
2929

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-format-jsonnet
33
title: kratos format jsonnet
4-
description: kratos format jsonnet
4+
description: kratos format jsonnet
55
---
66

77
<!--
@@ -21,28 +21,36 @@ Use -w or --write to write output back to files instead of stdout.
2121

2222
Glob Syntax:
2323

24-
pattern:
25-
{ term }
24+
```
25+
pattern:
26+
{ term }
27+
```
2628

27-
term:
28-
'*' matches any sequence of non-separator characters
29-
'**' matches any sequence of characters
30-
'?' matches any single non-separator character
31-
'[' [ '!' ] { character-range } ']'
32-
character class (must be non-empty)
33-
'{' pattern-list '}'
34-
pattern alternatives
35-
c matches character c (c != '*', '**', '?', '\', '[', '{', '}')
36-
'\' c matches character c
29+
```
30+
term:
31+
'*' matches any sequence of non-separator characters
32+
'**' matches any sequence of characters
33+
'?' matches any single non-separator character
34+
'[' [ '!' ] { character-range } ']'
35+
character class (must be non-empty)
36+
'{' pattern-list '}'
37+
pattern alternatives
38+
c matches character c (c != '*', '**', '?', '\', '[', '{', '}')
39+
'\' c matches character c
40+
```
3741

38-
character-range:
39-
c matches character c (c != '\\', '-', ']')
40-
'\' c matches character c
41-
lo '-' hi matches character c for lo <= c <= hi
42+
```
43+
character-range:
44+
c matches character c (c != '\\', '-', ']')
45+
'\' c matches character c
46+
lo '-' hi matches character c for lo <= c <= hi
47+
```
4248

43-
pattern-list:
44-
pattern { ',' pattern }
45-
comma-separated (without spaces) patterns
49+
```
50+
pattern-list:
51+
pattern { ',' pattern }
52+
comma-separated (without spaces) patterns
53+
```
4654

4755
```
4856
kratos format jsonnet path/to/files/*.jsonnet [more/files.jsonnet] [supports/**/{foo,bar}.jsonnet] [flags]
@@ -55,7 +63,7 @@ kratos format jsonnet path/to/files/*.jsonnet [more/files.jsonnet] [supports/**/
5563
-w, --write Write formatted output back to file.
5664
```
5765

58-
### SEE ALSO
66+
### See also
5967

60-
* [kratos format](kratos-format) - Helpers for formatting code
68+
* [kratos format](kratos-format) Helpers for formatting code
6169

docs/kratos/cli/kratos-format.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-format
33
title: kratos format
4-
description: kratos format Helpers for formatting code
4+
description: kratos format
55
---
66

77
<!--
@@ -19,8 +19,8 @@ Helpers for formatting code
1919
-h, --help help for format
2020
```
2121

22-
### SEE ALSO
22+
### See also
2323

24-
* [kratos](kratos) -
25-
* [kratos format jsonnet](kratos-format-jsonnet) -
24+
* [kratos](kratos)
25+
* [kratos format jsonnet](kratos-format-jsonnet)
2626

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-get-identity
33
title: kratos get identity
4-
description: kratos get identity Get one or more identities by their ID(s)
4+
description: kratos get identity
55
---
66

77
<!--
@@ -46,7 +46,7 @@ To get the identities with the recovery email address at the domain "ory.sh", ru
4646
-q, --quiet Be quiet with output printing.
4747
```
4848

49-
### SEE ALSO
49+
### See also
5050

51-
* [kratos get](kratos-get) - Get resources
51+
* [kratos get](kratos-get) Get resources
5252

docs/kratos/cli/kratos-get.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: kratos-get
33
title: kratos get
4-
description: kratos get Get resources
4+
description: kratos get
55
---
66

77
<!--
@@ -22,8 +22,8 @@ Get resources
2222
-q, --quiet Be quiet with output printing.
2323
```
2424

25-
### SEE ALSO
25+
### See also
2626

27-
* [kratos](kratos) -
27+
* [kratos](kratos)
2828
* [kratos get identity](kratos-get-identity) - Get one or more identities by their ID(s)
2929

0 commit comments

Comments
 (0)