rook - A secret service tool backed by a Keepass v4 database.
NAME SYNOPSIS DESCRIPTION OPTIONS COMMANDS commands exit help info list lock match open reload search serve show status version AUTHOR SEE ALSONAME
rook − A secret service tool backed by a Keepass v4 database.
SYNOPSIS
rook [--force/-f <bool>] [--help/-h <bool>] [--keyring/-k <bool>] [--password <string>] [--pin <bool>] [--socket <string>] [--version/-v <bool>] [commands|exit|help|info|list|lock|match|open|reload|search|serve|show|status|version]
DESCRIPTION
Rook allows you to use a KeePass v2 database as storage for secrets. It provides client and server modes; the server unlocks the database and stays in memory, while the client communicates over a socket with the server and fetches data.
OPTIONS
--force, -f[=bool] (defaults to false)
purge any existing server socket first. If there’s already a server running, this will probably break it.
--help, -h[=bool] (defaults to false)
Prints usage text
--keyring, -k[=bool] (defaults to false)
use the Linux kernel keyring to store the pin in the user session context. Enables (and overrides) --secure.
--password[=string] (defaults to "")
Do not use this argument. It’s a horrible idea.
--pin[=bool] (defaults to false)
Read the secret pin from the STDIN
--socket[=string] (defaults to "")
an alternate client/server socket from the default (allows running multiple rook servers). Must be a full file name, e.g. /tmp/rook2.sock
--version, -v[=bool] (defaults to false)
print the version and exit
COMMANDS
commands
list all of the supported server commands
exit
kill background process
help
Prints usage text
info
print database information
list
list entries in the database
lock
lock an open database
match
find entries who have titles, urls, or autocomplete entries matching the supplied string. This is the opposite of search, in that the entry records must be substrings of the argument.
open
open a new database, or unlock the existing one. The password may either be prompted for, or may be supplied in a ROOK_PASSWORD environment variable.
reload
reload the database. This shouldn’t be necessary as rook detects file system mod time changes and auto-refreshes, but this command can force it.
search
list entries with title, URL, or tag matching a string
serve
start the server
show
show the contents of an entry
status
report whether the DB is unlocked. Lighter call than info
version
print out the version and exit
AUTHOR
Sean E. Russell <[email protected]>
SEE ALSO
rook(1) rook-commands(1) rook-exit(1) rook-help(1) rook-info(1) rook-list(1) rook-lock(1) rook-match(1) rook-open(1) rook-reload(1) rook-search(1) rook-serve(1) rook-show(1) rook-status(1) rook-version(1)