diff --git a/docs/website/references/cli/defradb.md b/docs/website/references/cli/defradb.md index 3edc08b8d9..f2a6c85840 100644 --- a/docs/website/references/cli/defradb.md +++ b/docs/website/references/cli/defradb.md @@ -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 diff --git a/docs/website/references/cli/defradb_identity.md b/docs/website/references/cli/defradb_identity.md new file mode 100644 index 0000000000..1f658047b2 --- /dev/null +++ b/docs/website/references/cli/defradb_identity.md @@ -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 ,=,...;,... + --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 + diff --git a/docs/website/references/cli/defradb_identity_new.md b/docs/website/references/cli/defradb_identity_new.md new file mode 100644 index 0000000000..dd8cf0af7b --- /dev/null +++ b/docs/website/references/cli/defradb_identity_new.md @@ -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 ,=,...;,... + --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 +