Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 1.37 KB

kdb-shell.md

File metadata and controls

54 lines (39 loc) · 1.37 KB

kdb-shell(1) -- Start a kdb shell instance

SYNOPSIS

kdb shell

DESCRIPTION

This command is used to start an instance of the kdb shell.
The kdb shell allows for a user to interactively view, edit, or otherwise work with the key database.

SHELL COMMANDS

The kdb shell offers a number of commands to interact with the key database.

  • kdbGet <name>: Get the value of a key.

  • kdbSet <name>: Set the value of a key.

  • keySetName <name>: Set the name of the current key.

  • keySetMeta <name> <string>: Set a metakey associated with the current key.

  • keySetString <string>: Set a string value for the current key.

  • ksAppendKey: Append the current key to the current keyset.

  • ksCut <name>: Cut the current keyset.

  • ksOutput: Prints the keys in the current keyset.

OPTIONS

  • -H, --help: Show the man page.
  • -V, --version: Print version info.
  • -p, --profile <profile>: Use a different kdb profile.
  • -C, --color <when>: Print never/auto(default)/always colored output.

EXAMPLES

To execute commands from a textfile, you can use:
cat commands.txt | kdb shell

To have readline functionality (line editing, history, ...), you can use:
rlwrap kdb shell

SEE ALSO

To learn more about these commands and how they work, refer to the Elektra API Documentation.