Skip to content

Commit

Permalink
docs: added sidebar cli label
Browse files Browse the repository at this point in the history
`clidoc.Generate` expects to find an entry under `sidebar.json/Reference` that contains the substring "CLI" in it's label. Because that was missing, a new entry was appended on every regeneration of the file.
  • Loading branch information
zepatrik authored and aeneasr committed Oct 13, 2020
1 parent b037a1e commit 5d24a29
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 60 deletions.
11 changes: 3 additions & 8 deletions docs/docs/cli/kratos-identities-delete.md
Expand Up @@ -17,21 +17,16 @@ 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.
Example: delete the identity with the recovery email address "foo@bar.com":

kratos identities delete \$(kratos identities list --format json | jq -r 'map(select(.recovery_addresses[].value == "foo@bar.com")) | .[].id')

We have to admit, this is not easy if you don'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 <id-0 [id-1 ...]> [flags]
```

### Examples

```
To delete the identity with the recovery email address "foo@bar.com", run:
$ kratos identities delete $(kratos identities list --format json | jq -r 'map(select(.recovery_addresses[].value == "foo@bar.com")) | .[].id')
```

### Options

```
Expand Down
11 changes: 3 additions & 8 deletions docs/docs/cli/kratos-identities-get.md
Expand Up @@ -17,21 +17,16 @@ 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.
Example: get the identities with the recovery email address at the domain "ory.sh":

kratos identities get \$(kratos identities list --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')

We have to admit, this is not easy if you don'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 <id-0 [id-1 ...]> [flags]
```

### Examples

```
To get the identities with the recovery email address at the domain "ory.sh", run:
$ kratos identities get $(kratos identities list --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')
```

### Options

```
Expand Down
13 changes: 5 additions & 8 deletions docs/docs/cli/kratos-identities-import.md
Expand Up @@ -16,7 +16,11 @@ Import identities from files or STD_IN

### Synopsis

Import identities from files or STD_IN.
Import identities from files or STD_IN:

kratos identities import file.json

cat file.json | kratos identities import

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

Expand All @@ -26,13 +30,6 @@ WARNING: Importing credentials is not yet supported.
kratos identities import <file.json [file-2.json [file-3.json] ...]> [flags]
```

### Examples

```
$ kratos identities import file.json
$ cat file.json | kratos identities import
```

### Options

```
Expand Down
38 changes: 2 additions & 36 deletions docs/sidebar.json
Expand Up @@ -52,42 +52,8 @@
"reference/html-forms",
"reference/api",
{
"items": [
"cli/kratos",
"cli/kratos-identities",
"cli/kratos-identities-delete",
"cli/kratos-identities-get",
"cli/kratos-identities-import",
"cli/kratos-identities-list",
"cli/kratos-identities-patch",
"cli/kratos-identities-validate",
"cli/kratos-jsonnet",
"cli/kratos-jsonnet-format",
"cli/kratos-jsonnet-lint",
"cli/kratos-remote",
"cli/kratos-remote-status",
"cli/kratos-remote-version"
]
},
{
"items": [
"cli/kratos",
"cli/kratos-identities",
"cli/kratos-identities-delete",
"cli/kratos-identities-get",
"cli/kratos-identities-import",
"cli/kratos-identities-list",
"cli/kratos-identities-patch",
"cli/kratos-identities-validate",
"cli/kratos-jsonnet",
"cli/kratos-jsonnet-format",
"cli/kratos-jsonnet-lint",
"cli/kratos-remote",
"cli/kratos-remote-status",
"cli/kratos-remote-version"
]
},
{
"type": "category",
"label": "Command Line Interface (CLI)",
"items": [
"cli/kratos",
"cli/kratos-identities",
Expand Down

0 comments on commit 5d24a29

Please sign in to comment.