Skip to content

Commit

Permalink
PR(DOCS): Update the cli documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
shahzadlone committed Jun 24, 2024
1 parent 09b2c0d commit 1af8970
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/website/references/cli/defradb.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Start a DefraDB node, interact with a local or remote node, and much more.
### SEE ALSO

* [defradb client](defradb_client.md) - Interact with a DefraDB node
* [defradb identity](defradb_identity.md) - Interact with identity features of DefraDB instance
* [defradb keyring](defradb_keyring.md) - Manage DefraDB private keys
* [defradb server-dump](defradb_server-dump.md) - Dumps the state of the entire database
* [defradb start](defradb_start.md) - Start a DefraDB node
Expand Down
37 changes: 37 additions & 0 deletions docs/website/references/cli/defradb_identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## defradb identity

Interact with identity features of DefraDB instance

### Synopsis

Interact with identity features of DefraDB instance

### Options

```
-h, --help help for identity
```

### Options inherited from parent commands

```
--keyring-backend string Keyring backend to use. Options are file or system (default "file")
--keyring-namespace string Service name to use when using the system backend (default "defradb")
--keyring-path string Path to store encrypted keys when using the file backend (default "keys")
--log-format string Log format to use. Options are text or json (default "text")
--log-level string Log level to use. Options are debug, info, error, fatal (default "info")
--log-output string Log output path. Options are stderr or stdout. (default "stderr")
--log-overrides string Logger config overrides. Format <name>,<key>=<val>,...;<name>,...
--log-source Include source location in logs
--log-stacktrace Include stacktrace in error and fatal logs
--no-keyring Disable the keyring and generate ephemeral keys
--no-log-color Disable colored log output
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
```

### SEE ALSO

* [defradb](defradb.md) - DefraDB Edge Database
* [defradb identity new](defradb_identity_new.md) - Generate a new identity

45 changes: 45 additions & 0 deletions docs/website/references/cli/defradb_identity_new.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## defradb identity new

Generate a new identity

### Synopsis

Generate a new identity

Example: generate a new identity:
defradb identity new



```
defradb identity new [flags]
```

### Options

```
-h, --help help for new
```

### Options inherited from parent commands

```
--keyring-backend string Keyring backend to use. Options are file or system (default "file")
--keyring-namespace string Service name to use when using the system backend (default "defradb")
--keyring-path string Path to store encrypted keys when using the file backend (default "keys")
--log-format string Log format to use. Options are text or json (default "text")
--log-level string Log level to use. Options are debug, info, error, fatal (default "info")
--log-output string Log output path. Options are stderr or stdout. (default "stderr")
--log-overrides string Logger config overrides. Format <name>,<key>=<val>,...;<name>,...
--log-source Include source location in logs
--log-stacktrace Include stacktrace in error and fatal logs
--no-keyring Disable the keyring and generate ephemeral keys
--no-log-color Disable colored log output
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
```

### SEE ALSO

* [defradb identity](defradb_identity.md) - Interact with identity features of DefraDB instance

0 comments on commit 1af8970

Please sign in to comment.